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

Returns a new instance of 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.

Rate limits:
Burst: 3/s<br>Steady: 15/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

Returns:

  • (nil) 


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.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `15/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

Returns:

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

    nil, response status code and response headers



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-07-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

#bulk_delete_object_records(object_record_delete_job_create_query, opts = {}) ⇒ nil Also known as: create_object_record_bulk_delete_job

Bulk Delete Object Records Delete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

Returns:

  • (nil) 


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

def bulk_delete_object_records(object_record_delete_job_create_query, opts = {})
  bulk_delete_object_records_with_http_info(object_record_delete_job_create_query, opts)
  nil
end

#bulk_delete_object_records_with_http_info(object_record_delete_job_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_object_record_bulk_delete_job_with_http_info

Bulk Delete Object Records Delete a batch of object records. Accepts up to 500 object record IDs per request. The maximum allowed payload size is 5MB.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

Returns:

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

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

def bulk_delete_object_records_with_http_info(object_record_delete_job_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.bulk_delete_object_records ...'
  end
  # verify the required parameter 'object_record_delete_job_create_query' is set
  if @api_client.config.client_side_validation && object_record_delete_job_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_record_delete_job_create_query' when calling CustomObjectsApi.bulk_delete_object_records"
  end
  # resource path
  local_var_path = '/api/object-record-bulk-delete-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-07-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(object_record_delete_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_delete_object_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_delete_object_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<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • data_source_create_query (DataSourceCreateQuery) —

    Create data source

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


179
180
181
182
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 179

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.

Rate limits:
Burst: 75/s<br>Steady: 750/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

Returns:

  • (nil) 


255
256
257
258
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 255

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.<br><br>Rate limits:<br>Burst: `75/s`<br>Steady: `750/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

Returns:

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

    nil, response status code and response headers



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
319
320
321
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 268

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-07-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<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • data_source_create_query (DataSourceCreateQuery) —

    Create data source

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
245
246
247
248
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 190

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
  allowable_values = ["description", "id", "namespace", "title", "visibility"]
  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'

  # 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-07-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

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

Create Object Schema Create an object schema.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • object_schema_create_query (ObjectSchemaCreateQuery) —

    Create an object schema

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


332
333
334
335
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 332

def create_object_schema(object_schema_create_query, opts = {})
  data, _status_code, _headers = create_object_schema_with_http_info(object_schema_create_query, opts)
  data
end

#create_object_schema_relationship(id, object_schema_relationship_create_query, opts = {}) ⇒ nil Also known as: add_schemas_to_object_schema, create_object_schema_relationships_schemas

Create Object Schema Relationship Create a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object relationships.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_create_query (ObjectSchemaRelationshipCreateQuery) —

    Create a relationship between object schemas

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

    the optional parameters

Returns:

  • (nil) 


409
410
411
412
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 409

def create_object_schema_relationship(id, object_schema_relationship_create_query, opts = {})
  create_object_schema_relationship_with_http_info(id, object_schema_relationship_create_query, opts)
  nil
end

#create_object_schema_relationship_with_http_info(id, object_schema_relationship_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: add_schemas_to_object_schema_with_http_info, create_object_schema_relationships_schemas_with_http_info

Create Object Schema Relationship Create a relationship between object schemas. Note that flow filtering and segmentation are currently not supported for object-to-object relationships.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_create_query (ObjectSchemaRelationshipCreateQuery) —

    Create a relationship between object schemas

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 426

def create_object_schema_relationship_with_http_info(id, object_schema_relationship_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_schema_relationship ...'
  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.create_object_schema_relationship"
  end
  # verify the required parameter 'object_schema_relationship_create_query' is set
  if @api_client.config.client_side_validation && object_schema_relationship_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_schema_relationship_create_query' when calling CustomObjectsApi.create_object_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.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-07-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(object_schema_relationship_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_object_schema_relationship",
    :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_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create Object Schema Create an object schema.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • object_schema_create_query (ObjectSchemaCreateQuery) —

    Create an object schema

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
394
395
396
397
398
399
400
401
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 343

def create_object_schema_with_http_info(object_schema_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_schema ...'
  end
  # verify the required parameter 'object_schema_create_query' is set
  if @api_client.config.client_side_validation && object_schema_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_schema_create_query' when calling CustomObjectsApi.create_object_schema"
  end
  allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
  if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-schemas'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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(object_schema_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_object_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Create Object Type Create an object type.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • object_type_create_query (ObjectTypeCreateQuery) —

    Create an object type

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


497
498
499
500
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 497

def create_object_type(object_type_create_query, opts = {})
  data, _status_code, _headers = create_object_type_with_http_info(object_type_create_query, opts)
  data
end

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

Create Object Type Create an object type.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • object_type_create_query (ObjectTypeCreateQuery) —

    Create an object type

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 508

def create_object_type_with_http_info(object_type_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_object_type ...'
  end
  # verify the required parameter 'object_type_create_query' is set
  if @api_client.config.client_side_validation && object_type_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_type_create_query' when calling CustomObjectsApi.create_object_type"
  end
  allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-types'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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(object_type_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_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#create_profile_schema_relationship(id, profile_object_schema_relationship_create_query, opts = {}) ⇒ nil Also known as: add_profile_object_schemas_to_object_schema, create_object_schema_relationships_profile_object_schemas

Create Profile Schema Relationship Create a relationship between an object schema and a profile

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_create_query (ProfileObjectSchemaRelationshipCreateQuery) —

    Create a relationship between an object schema and a profile.

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

    the optional parameters

Returns:

  • (nil) 


574
575
576
577
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 574

def create_profile_schema_relationship(id, profile_object_schema_relationship_create_query, opts = {})
  create_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_create_query, opts)
  nil
end

#create_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: add_profile_object_schemas_to_object_schema_with_http_info, create_object_schema_relationships_profile_object_schemas_with_http_info

Create Profile Schema Relationship Create a relationship between an object schema and a profile<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_create_query (ProfileObjectSchemaRelationshipCreateQuery) —

    Create a relationship between an object schema and a profile.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 591

def create_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_profile_schema_relationship ...'
  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.create_profile_schema_relationship"
  end
  # verify the required parameter 'profile_object_schema_relationship_create_query' is set
  if @api_client.config.client_side_validation && profile_object_schema_relationship_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_create_query' when calling CustomObjectsApi.create_profile_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.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-07-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(profile_object_schema_relationship_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_profile_schema_relationship",
    :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_profile_schema_relationship\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<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the data source to delete

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

    the optional parameters

Returns:

  • (nil) 


661
662
663
664
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 661

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.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the data source to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
713
714
715
716
717
718
719
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 671

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-07-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

#delete_object_schema_relationship(id, object_schema_relationship_delete_query, opts = {}) ⇒ nil Also known as: delete_object_schema_relationships_schemas, remove_schemas_from_object_schema

Delete Object Schema Relationship Delete a relationship between object schemas

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_delete_query (ObjectSchemaRelationshipDeleteQuery) —

    Delete a relationship between object schemas

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

    the optional parameters

Returns:

  • (nil) 


727
728
729
730
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 727

def delete_object_schema_relationship(id, object_schema_relationship_delete_query, opts = {})
  delete_object_schema_relationship_with_http_info(id, object_schema_relationship_delete_query, opts)
  nil
end

#delete_object_schema_relationship_with_http_info(id, object_schema_relationship_delete_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_object_schema_relationships_schemas_with_http_info, remove_schemas_from_object_schema_with_http_info

Delete Object Schema Relationship Delete a relationship between object schemas<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_delete_query (ObjectSchemaRelationshipDeleteQuery) —

    Delete a relationship between object schemas

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 744

def delete_object_schema_relationship_with_http_info(id, object_schema_relationship_delete_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_object_schema_relationship ...'
  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_object_schema_relationship"
  end
  # verify the required parameter 'object_schema_relationship_delete_query' is set
  if @api_client.config.client_side_validation && object_schema_relationship_delete_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_schema_relationship_delete_query' when calling CustomObjectsApi.delete_object_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.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-07-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(object_schema_relationship_delete_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.delete_object_schema_relationship",
    :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_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Object Type Delete the object type with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (nil) 


814
815
816
817
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 814

def delete_object_type(id, opts = {})
  delete_object_type_with_http_info(id, opts)
  nil
end

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

Delete Object Type Delete the object type with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 824

def delete_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_object_type"
  end
  # resource path
  local_var_path = '/api/object-types/{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-07-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_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#delete_profile_schema_relationship(id, profile_object_schema_relationship_delete_query, opts = {}) ⇒ nil Also known as: delete_object_schema_relationships_profile_object_schemas, remove_profile_object_schemas_from_object_schema

Delete Profile Schema Relationship Delete a relationship between an object schema and a profile

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_delete_query (ProfileObjectSchemaRelationshipDeleteQuery) —

    Delete a relationship between an object schema and a profile

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

    the optional parameters

Returns:

  • (nil) 


880
881
882
883
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 880

def delete_profile_schema_relationship(id, profile_object_schema_relationship_delete_query, opts = {})
  delete_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_delete_query, opts)
  nil
end

#delete_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_delete_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: delete_object_schema_relationships_profile_object_schemas_with_http_info, remove_profile_object_schemas_from_object_schema_with_http_info

Delete Profile Schema Relationship Delete a relationship between an object schema and a profile<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_delete_query (ProfileObjectSchemaRelationshipDeleteQuery) —

    Delete a relationship between an object schema and a profile

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 897

def delete_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_delete_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_profile_schema_relationship ...'
  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_profile_schema_relationship"
  end
  # verify the required parameter 'profile_object_schema_relationship_delete_query' is set
  if @api_client.config.client_side_validation && profile_object_schema_relationship_delete_query.nil?
    fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_delete_query' when calling CustomObjectsApi.delete_profile_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.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-07-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(profile_object_schema_relationship_delete_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.delete_profile_schema_relationship",
    :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_profile_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_current_schema_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_current_schema

Get Current Schema for Object Type Get current schema for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


968
969
970
971
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 968

def get_current_schema_for_object_type(id, opts = {})
  data, _status_code, _headers = get_current_schema_for_object_type_with_http_info(id, opts)
  data
end

#get_current_schema_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_current_schema_with_http_info

Get Current Schema for Object Type Get current schema for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 982

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_current_schema_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_current_schema_id_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_current_schema

Get Current Schema ID for Object Type Get current schema for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1045
1046
1047
1048
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1045

def get_current_schema_id_for_object_type(id, opts = {})
  data, _status_code, _headers = get_current_schema_id_for_object_type_with_http_info(id, opts)
  data
end

#get_current_schema_id_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_current_schema_with_http_info

Get Current Schema ID for Object Type Get current schema for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1058

def get_current_schema_id_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_current_schema_id_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_current_schema_id_for_object_type"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/relationships/current-schema'.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-07-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_current_schema_id_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomObjectsApi#get_current_schema_id_for_object_type\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<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the data source

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1117
1118
1119
1120
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1117

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.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the data source

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1128

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 = ["description", "id", "namespace", "title", "visibility"]
  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-07-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<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1190
1191
1192
1193
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1190

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.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1202

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 = ["description", "id", "namespace", "title", "visibility"]
  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-07-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

#get_draft_schema_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_draft_schema

Get Draft Schema for Object Type Get draft schema for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1269
1270
1271
1272
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1269

def get_draft_schema_for_object_type(id, opts = {})
  data, _status_code, _headers = get_draft_schema_for_object_type_with_http_info(id, opts)
  data
end

#get_draft_schema_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_draft_schema_with_http_info

Get Draft Schema for Object Type Get draft schema for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1283

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_draft_schema_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_draft_schema_id_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_draft_schema

Get Draft Schema ID for Object Type Get draft schema for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1346
1347
1348
1349
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1346

def get_draft_schema_id_for_object_type(id, opts = {})
  data, _status_code, _headers = get_draft_schema_id_for_object_type_with_http_info(id, opts)
  data
end

#get_draft_schema_id_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_draft_schema_with_http_info

Get Draft Schema ID for Object Type Get draft schema for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1359

def get_draft_schema_id_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_draft_schema_id_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_draft_schema_id_for_object_type"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/relationships/draft-schema'.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-07-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_draft_schema_id_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_ingestion_log_ids_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_ingestion_logs

Get Ingestion Log IDs for Object Type Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1419
1420
1421
1422
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1419

def get_ingestion_log_ids_for_object_type(id, opts = {})
  data, _status_code, _headers = get_ingestion_log_ids_for_object_type_with_http_info(id, opts)
  data
end

#get_ingestion_log_ids_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_ingestion_logs_with_http_info

Get Ingestion Log IDs for Object Type Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1434

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_ingestion_log_ids_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_ingestion_logs_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_ingestion_logs

Get Ingestion Logs for Object Type Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.

Rate limits:
Burst: 1/s<br>Steady: 15/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1500
1501
1502
1503
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1500

def get_ingestion_logs_for_object_type(id, opts = {})
  data, _status_code, _headers = get_ingestion_logs_for_object_type_with_http_info(id, opts)
  data
end

#get_ingestion_logs_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_ingestion_logs_with_http_info

Get Ingestion Logs for Object Type Get the ingestion logs for a given object type. Only ingestion failures are logged — the absence of a log entry for a record does not mean the record was ingested successfully. Logs are retained for 14 days; time filters outside that window return an empty page. Results are returned newest first with a fixed page size of 50.<br><br>Rate limits:<br>Burst: `1/s`<br>Steady: `15/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1519

def get_ingestion_logs_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_ingestion_logs_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_ingestion_logs_for_object_type"
  end
  allowable_values = ["errors", "event_type", "id", "status", "summary", "timestamp"]
  if @api_client.config.client_side_validation && opts[:'fields_object_ingestion_log'] && !opts[:'fields_object_ingestion_log'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_ingestion_log\", must include one of #{allowable_values}"
  end
  allowable_values = ["id", "record_properties"]
  if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_record\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
  end
  allowable_values = ["object-record", "object-type"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/object-ingestion-logs'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[object-ingestion-log]'] = @api_client.build_collection_param(opts[:'fields_object_ingestion_log'], :csv) if !opts[:'fields_object_ingestion_log'].nil?
  query_params[:'fields[object-record]'] = @api_client.build_collection_param(opts[:'fields_object_record'], :csv) if !opts[:'fields_object_record'].nil?
  query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_ingestion_logs_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Get Object Record Get the object record with the given compound ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The compound ID of the object record, formatted as object_type_id:::object_record_id

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1600
1601
1602
1603
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1600

def get_object_record(id, opts = {})
  data, _status_code, _headers = get_object_record_with_http_info(id, opts)
  data
end

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

Get Object Record Get the object record with the given compound ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The compound ID of the object record, formatted as object_type_id:::object_record_id

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1611

def get_object_record_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_record ...'
  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_object_record"
  end
  allowable_values = ["id", "record_properties"]
  if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_record\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-records/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_object_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomObjectsApi#get_object_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Object Schema Get the object schema with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1675
1676
1677
1678
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1675

def get_object_schema(id, opts = {})
  data, _status_code, _headers = get_object_schema_with_http_info(id, opts)
  data
end

#get_object_schema_relationships(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_schema_relationships_schemas, get_schema_ids_for_object_schema

Get Object Schema Relationships Get related object schemas for an object schema

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1764
1765
1766
1767
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1764

def get_object_schema_relationships(id, opts = {})
  data, _status_code, _headers = get_object_schema_relationships_with_http_info(id, opts)
  data
end

#get_object_schema_relationships_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_schema_relationships_schemas_with_http_info, get_schema_ids_for_object_schema_with_http_info

Get Object Schema Relationships Get related object schemas for an object schema<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1780

def get_object_schema_relationships_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_schema_relationships ...'
  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_object_schema_relationships"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.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-07-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_object_schema_relationships",
    :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_object_schema_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Object Schema Get the object schema with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1689

def get_object_schema_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_schema ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_schema"
  end
  allowable_values = ["description", "id", "meta", "meta.description", "meta.name", "meta.relationship_id", "properties", "published_at", "required", "status", "title", "visibility"]
  if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
  end
  allowable_values = ["id", "meta", "meta.description", "meta.name", "meta.relationship_id"]
  if @api_client.config.client_side_validation && opts[:'fields_profile_object_schema'] && !opts[:'fields_profile_object_schema'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_profile_object_schema\", must include one of #{allowable_values}"
  end
  allowable_values = ["id", "property_mappings", "relationship_mappings"]
  if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
  end
  allowable_values = ["object-schemas", "profile-object-schemas", "source-mapping"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
  query_params[:'fields[profile-object-schema]'] = @api_client.build_collection_param(opts[:'fields_profile_object_schema'], :csv) if !opts[:'fields_profile_object_schema'].nil?
  query_params[:'fields[source-mapping]'] = @api_client.build_collection_param(opts[:'fields_source_mapping'], :csv) if !opts[:'fields_source_mapping'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_object_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Get Object Type Get the object type with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


1845
1846
1847
1848
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1845

def get_object_type(id, opts = {})
  data, _status_code, _headers = get_object_type_with_http_info(id, opts)
  data
end

#get_object_type_relationships(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_types, get_type_ids_for_object_type

Get Object Type Relationships Get related object types for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1934
1935
1936
1937
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1934

def get_object_type_relationships(id, opts = {})
  data, _status_code, _headers = get_object_type_relationships_with_http_info(id, opts)
  data
end

#get_object_type_relationships_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_types_with_http_info, get_type_ids_for_object_type_with_http_info

Get Object Type Relationships Get related object types for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1950

def get_object_type_relationships_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_type_relationships ...'
  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_object_type_relationships"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/relationships/object-types'.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-07-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_object_type_relationships",
    :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_object_type_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Object Type Get the object type with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 1859

def get_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_object_type"
  end
  allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
  if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "description", "id", "meta", "meta.description", "meta.name", "meta.relationship_id", "namespace", "status", "title", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
  end
  allowable_values = ["id", "meta", "meta.description", "meta.name", "meta.relationship_id"]
  if @api_client.config.client_side_validation && opts[:'fields_profile_object_type'] && !opts[:'fields_profile_object_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_profile_object_type\", must include one of #{allowable_values}"
  end
  allowable_values = ["current-schema", "draft-schema", "object-types", "profile-object-types", "schema-versions"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-types/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
  query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
  query_params[:'fields[profile-object-type]'] = @api_client.build_collection_param(opts[:'fields_profile_object_type'], :csv) if !opts[:'fields_profile_object_type'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Get Object Types Get all object types in an account.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2014
2015
2016
2017
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2014

def get_object_types(opts = {})
  data, _status_code, _headers = get_object_types_with_http_info(opts)
  data
end

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

Get Object Types Get all object types in an account.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2027

def get_object_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_object_types ...'
  end
  allowable_values = ["description", "id", "properties", "published_at", "required", "status", "title", "visibility"]
  if @api_client.config.client_side_validation && opts[:'fields_object_schema'] && !opts[:'fields_object_schema'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_schema\", must include one of #{allowable_values}"
  end
  allowable_values = ["created_at", "description", "id", "namespace", "status", "title", "updated_at"]
  if @api_client.config.client_side_validation && opts[:'fields_object_type'] && !opts[:'fields_object_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_type\", must include one of #{allowable_values}"
  end
  allowable_values = ["current-schema", "draft-schema"]
  if @api_client.config.client_side_validation && opts[:'include'] && !opts[:'include'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"include\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-types'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[object-schema]'] = @api_client.build_collection_param(opts[:'fields_object_schema'], :csv) if !opts[:'fields_object_schema'].nil?
  query_params[:'fields[object-type]'] = @api_client.build_collection_param(opts[:'fields_object_type'], :csv) if !opts[:'fields_object_type'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_object_types",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_profile_schema_relationships(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_schema_relationships_profile_object_schemas, get_profile_object_schema_ids_for_object_schema

Get Profile Schema Relationships Get related profile object schemas for an object schema

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


2094
2095
2096
2097
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2094

def get_profile_schema_relationships(id, opts = {})
  data, _status_code, _headers = get_profile_schema_relationships_with_http_info(id, opts)
  data
end

#get_profile_schema_relationships_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_schema_relationships_profile_object_schemas_with_http_info, get_profile_object_schema_ids_for_object_schema_with_http_info

Get Profile Schema Relationships Get related profile object schemas for an object schema<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2110

def get_profile_schema_relationships_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_profile_schema_relationships ...'
  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_profile_schema_relationships"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.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-07-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_profile_schema_relationships",
    :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_profile_schema_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_profile_type_relationships(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_profile_object_types, get_profile_object_type_ids_for_object_type

Get Profile Type Relationships Get related profile object types for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


2171
2172
2173
2174
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2171

def get_profile_type_relationships(id, opts = {})
  data, _status_code, _headers = get_profile_type_relationships_with_http_info(id, opts)
  data
end

#get_profile_type_relationships_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_profile_object_types_with_http_info, get_profile_object_type_ids_for_object_type_with_http_info

Get Profile Type Relationships Get related profile object types for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2187

def get_profile_type_relationships_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_profile_type_relationships ...'
  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_profile_type_relationships"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/relationships/profile-object-types'.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-07-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_profile_type_relationships",
    :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_profile_type_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_record_ids_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_records

Get Record IDs for Object Type Get all object records for a given object type.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2250
2251
2252
2253
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2250

def get_record_ids_for_object_type(id, opts = {})
  data, _status_code, _headers = get_record_ids_for_object_type_with_http_info(id, opts)
  data
end

#get_record_ids_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_records_with_http_info

Get Record IDs for Object Type Get all object records for a given object type.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2265

def get_record_ids_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_record_ids_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_record_ids_for_object_type"
  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_record_ids_for_object_type, 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_record_ids_for_object_type, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/object-types/{id}/relationships/object-records'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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-07-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_record_ids_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_records_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_records

Get Records for Object Type Get all object records for a given object type.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2336
2337
2338
2339
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2336

def get_records_for_object_type(id, opts = {})
  data, _status_code, _headers = get_records_for_object_type_with_http_info(id, opts)
  data
end

#get_records_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_records_with_http_info

Get Records for Object Type Get all object records for a given object type.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2352

def get_records_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_records_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_records_for_object_type"
  end
  allowable_values = ["id", "record_properties"]
  if @api_client.config.client_side_validation && opts[:'fields_object_record'] && !opts[:'fields_object_record'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_object_record\", 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_records_for_object_type, 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_records_for_object_type, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/object-types/{id}/object-records'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[object-record]'] = @api_client.build_collection_param(opts[:'fields_object_record'], :csv) if !opts[:'fields_object_record'].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-07-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_records_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_schema_version_ids_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_relationships_schema_versions

Get Schema Version IDs for Object Type Get all schema versions for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


2425
2426
2427
2428
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2425

def get_schema_version_ids_for_object_type(id, opts = {})
  data, _status_code, _headers = get_schema_version_ids_for_object_type_with_http_info(id, opts)
  data
end

#get_schema_version_ids_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_relationships_schema_versions_with_http_info

Get Schema Version IDs for Object Type Get all schema versions for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2438

def get_schema_version_ids_for_object_type_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_schema_version_ids_for_object_type ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_schema_version_ids_for_object_type"
  end
  # resource path
  local_var_path = '/api/object-types/{id}/relationships/schema-versions'.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-07-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_schema_version_ids_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_schema_versions_for_object_type(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_type_schema_versions

Get Schema Versions for Object Type Get all schema versions for an object type

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2497
2498
2499
2500
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2497

def get_schema_versions_for_object_type(id, opts = {})
  data, _status_code, _headers = get_schema_versions_for_object_type_with_http_info(id, opts)
  data
end

#get_schema_versions_for_object_type_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_type_schema_versions_with_http_info

Get Schema Versions for Object Type Get all schema versions for an object type<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object type.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2511

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_schema_versions_for_object_type",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Get Source Mapping Get the source mapping with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the source mapping

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2575
2576
2577
2578
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2575

def get_source_mapping(id, opts = {})
  data, _status_code, _headers = get_source_mapping_with_http_info(id, opts)
  data
end

#get_source_mapping_for_object_schema(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_schema_source_mapping

Get Source Mapping for Object Schema Get source mapping for an object schema

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2647
2648
2649
2650
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2647

def get_source_mapping_for_object_schema(id, opts = {})
  data, _status_code, _headers = get_source_mapping_for_object_schema_with_http_info(id, opts)
  data
end

#get_source_mapping_for_object_schema_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_schema_source_mapping_with_http_info

Get Source Mapping for Object Schema Get source mapping for an object schema<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2661

def get_source_mapping_for_object_schema_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping_for_object_schema ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_source_mapping_for_object_schema"
  end
  allowable_values = ["id", "property_mappings", "relationship_mappings"]
  if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/source-mapping'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_source_mapping_for_object_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_source_mapping_id_for_object_schema(id, opts = {}) ⇒ Hash<String, Object> Also known as: get_object_schema_relationships_source_mapping

Get Source Mapping ID for Object Schema Get source mapping for an object schema

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:read OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


2724
2725
2726
2727
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2724

def get_source_mapping_id_for_object_schema(id, opts = {})
  data, _status_code, _headers = get_source_mapping_id_for_object_schema_with_http_info(id, opts)
  data
end

#get_source_mapping_id_for_object_schema_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)> Also known as: get_object_schema_relationships_source_mapping_with_http_info

Get Source Mapping ID for Object Schema Get source mapping for an object schema<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2737

def get_source_mapping_id_for_object_schema_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping_id_for_object_schema ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_source_mapping_id_for_object_schema"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/source-mapping'.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-07-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_source_mapping_id_for_object_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

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

Get Source Mapping Get the source mapping with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:read` OpenAPI Spec

Parameters:

  • id (String) —

    The ID of the source mapping

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2586

def get_source_mapping_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_source_mapping ...'
  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_source_mapping"
  end
  allowable_values = ["id", "property_mappings", "relationship_mappings"]
  if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/source-mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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_source_mapping",
    :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_source_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Object Schema Update the object schema with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_partial_update_query (ObjectSchemaPartialUpdateQuery) —

    Update a object schema by ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


2797
2798
2799
2800
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2797

def update_object_schema(id, object_schema_partial_update_query, opts = {})
  data, _status_code, _headers = update_object_schema_with_http_info(id, object_schema_partial_update_query, opts)
  data
end

#update_object_schema_relationship(id, object_schema_relationship_partial_update_query, opts = {}) ⇒ nil Also known as: update_object_schema_relationships_schemas, update_schemas_for_object_schema

Update Object Schema Relationship Update a relationship between object schemas

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_partial_update_query (ObjectSchemaRelationshipPartialUpdateQuery) —

    Update a relationship between object schemas

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

    the optional parameters

Returns:

  • (nil) 


2879
2880
2881
2882
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2879

def update_object_schema_relationship(id, object_schema_relationship_partial_update_query, opts = {})
  update_object_schema_relationship_with_http_info(id, object_schema_relationship_partial_update_query, opts)
  nil
end

#update_object_schema_relationship_with_http_info(id, object_schema_relationship_partial_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: update_object_schema_relationships_schemas_with_http_info, update_schemas_for_object_schema_with_http_info

Update Object Schema Relationship Update a relationship between object schemas<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_relationship_partial_update_query (ObjectSchemaRelationshipPartialUpdateQuery) —

    Update a relationship between object schemas

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2896

def update_object_schema_relationship_with_http_info(id, object_schema_relationship_partial_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_object_schema_relationship ...'
  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.update_object_schema_relationship"
  end
  # verify the required parameter 'object_schema_relationship_partial_update_query' is set
  if @api_client.config.client_side_validation && object_schema_relationship_partial_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'object_schema_relationship_partial_update_query' when calling CustomObjectsApi.update_object_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/object-schemas'.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-07-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(object_schema_relationship_partial_update_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.update_object_schema_relationship",
    :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: CustomObjectsApi#update_object_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Object Schema Update the object schema with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • object_schema_partial_update_query (ObjectSchemaPartialUpdateQuery) —

    Update a object schema by ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2809

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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(object_schema_partial_update_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.update_object_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#update_profile_schema_relationship(id, profile_object_schema_relationship_partial_update_query, opts = {}) ⇒ nil Also known as: update_object_schema_relationships_profile_object_schemas, update_profile_object_schemas_for_object_schema

Update Profile Schema Relationship Update a relationship between an object schema and a profile

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_partial_update_query (ProfileObjectSchemaRelationshipPartialUpdateQuery) —

    Update a relationship between an object schema and a profile

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

    the optional parameters

Returns:

  • (nil) 


2967
2968
2969
2970
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2967

def update_profile_schema_relationship(id, profile_object_schema_relationship_partial_update_query, opts = {})
  update_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_partial_update_query, opts)
  nil
end

#update_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_partial_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: update_object_schema_relationships_profile_object_schemas_with_http_info, update_profile_object_schemas_for_object_schema_with_http_info

Update Profile Schema Relationship Update a relationship between an object schema and a profile<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the object schema.

  • profile_object_schema_relationship_partial_update_query (ProfileObjectSchemaRelationshipPartialUpdateQuery) —

    Update a relationship between an object schema and a profile

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 2984

def update_profile_schema_relationship_with_http_info(id, profile_object_schema_relationship_partial_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_profile_schema_relationship ...'
  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.update_profile_schema_relationship"
  end
  # verify the required parameter 'profile_object_schema_relationship_partial_update_query' is set
  if @api_client.config.client_side_validation && profile_object_schema_relationship_partial_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'profile_object_schema_relationship_partial_update_query' when calling CustomObjectsApi.update_profile_schema_relationship"
  end
  # resource path
  local_var_path = '/api/object-schemas/{id}/relationships/profile-object-schemas'.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-07-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(profile_object_schema_relationship_partial_update_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.update_profile_schema_relationship",
    :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: CustomObjectsApi#update_profile_schema_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Source Mapping Update the source mapping with the given ID.

Rate limits:
Burst: 3/s<br>Steady: 60/m Scopes: custom-objects:write OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the source mapping

  • source_mapping_partial_update_query (SourceMappingPartialUpdateQuery) —

    Update a source mapping by ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Hash<String, Object>) 


3056
3057
3058
3059
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 3056

def update_source_mapping(id, source_mapping_partial_update_query, opts = {})
  data, _status_code, _headers = update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts)
  data
end

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

Update Source Mapping Update the source mapping with the given ID.<br><br>Rate limits:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `custom-objects:write` OpenAPI Spec

Parameters:

  • id (String) —

    The ULID ID of the source mapping

  • source_mapping_partial_update_query (SourceMappingPartialUpdateQuery) —

    Update a source mapping by ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 3068

def update_source_mapping_with_http_info(id, source_mapping_partial_update_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.update_source_mapping ...'
  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.update_source_mapping"
  end
  # verify the required parameter 'source_mapping_partial_update_query' is set
  if @api_client.config.client_side_validation && source_mapping_partial_update_query.nil?
    fail ArgumentError, "Missing the required parameter 'source_mapping_partial_update_query' when calling CustomObjectsApi.update_source_mapping"
  end
  allowable_values = ["id", "property_mappings", "relationship_mappings"]
  if @api_client.config.client_side_validation && opts[:'fields_source_mapping'] && !opts[:'fields_source_mapping'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_source_mapping\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/source-mappings/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-07-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(source_mapping_partial_update_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.update_source_mapping",
    :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: CustomObjectsApi#update_source_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end