Class: KlaviyoAPI::CatalogsApi
- Inherits:
-
Object
- Object
- KlaviyoAPI::CatalogsApi
- Defined in:
- lib/klaviyo-api-sdk/api/catalogs_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_back_in_stock_subscription(server_bis_subscription_create_query, opts = {}) ⇒ nil
Create Back In Stock Subscription Subscribe a profile to receive back in stock notifications.
-
#create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Back In Stock Subscription Subscribe a profile to receive back in stock notifications.
-
#create_catalog_category(catalog_category_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Category Create a new catalog category.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#create_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Create Catalog Category Relationships Items Create a new item relationship for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Catalog Category Relationships Items Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#create_catalog_category_with_http_info(catalog_category_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Category Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#create_catalog_item(catalog_item_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Item Create a new catalog item.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#create_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Create Catalog Item Relationships Categories Create a new catalog category relationship for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Catalog Item Relationships Categories Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#create_catalog_item_with_http_info(catalog_item_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Item Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#create_catalog_variant(catalog_variant_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Variant Create a new variant for a related catalog item.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Variant Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#delete_catalog_category(id, opts = {}) ⇒ nil
Delete Catalog Category Delete a catalog category using the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#delete_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Delete Catalog Category Relationships Items Delete item relationships for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Category Relationships Items Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#delete_catalog_category_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Category Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#delete_catalog_item(id, opts = {}) ⇒ nil
Delete Catalog Item Delete a catalog item with the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#delete_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Delete Catalog Item Relationships Categories Delete catalog category relationships for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Item Relationships Categories Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#delete_catalog_item_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Item Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#delete_catalog_variant(id, opts = {}) ⇒ nil
Delete Catalog Variant Delete a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#delete_catalog_variant_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Variant Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#get_catalog_categories(opts = {}) ⇒ Hash<String, Object>
Get Catalog Categories Get all catalog categories in an account.
-
#get_catalog_categories_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Categories Get all catalog categories in an account.
-
#get_catalog_category(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Get a catalog category with the given category ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`. -
#get_catalog_category_items(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Items Get all items in a category with the given category ID.
-
#get_catalog_category_items_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Items Get all items in a category with the given category ID.
-
#get_catalog_category_relationships_items(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Relationships Items Get all items in the given category ID.
-
#get_catalog_category_relationships_items_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Relationships Items Get all items in the given category ID.
-
#get_catalog_category_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`.
-
#get_catalog_item(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Get a specific catalog item with the given item ID.
-
#get_catalog_item_categories(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Categories Get all catalog categories that an item with the given item ID is in.
-
#get_catalog_item_categories_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Categories Get all catalog categories that an item with the given item ID is in.
-
#get_catalog_item_relationships_categories(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Relationships Categories Get all catalog categories that a particular item is in.
-
#get_catalog_item_relationships_categories_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Relationships Categories Get all catalog categories that a particular item is in.
-
#get_catalog_item_variants(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Variants Get all variants related to the given item ID.
-
#get_catalog_item_variants_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Variants Get all variants related to the given item ID.
-
#get_catalog_item_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Get a specific catalog item with the given item ID.
-
#get_catalog_items(opts = {}) ⇒ Hash<String, Object>
Get Catalog Items Get all catalog items in an account.
-
#get_catalog_items_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Items Get all catalog items in an account.
-
#get_catalog_variant(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Variant Get a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`. -
#get_catalog_variant_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Variant Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`.
-
#get_catalog_variants(opts = {}) ⇒ Hash<String, Object>
Get Catalog Variants Get all variants in an account.
-
#get_catalog_variants_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Variants Get all variants in an account.
-
#get_create_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Categories Job Get a catalog category bulk create job with the given job ID.
-
#get_create_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Categories Job Get a catalog category bulk create job with the given job ID.
-
#get_create_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Categories Jobs Get all catalog category bulk create jobs.
-
#get_create_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Categories Jobs Get all catalog category bulk create jobs.
-
#get_create_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Items Job Get a catalog item bulk create job with the given job ID.
-
#get_create_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Items Job Get a catalog item bulk create job with the given job ID.
-
#get_create_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Items Jobs Get all catalog item bulk create jobs.
-
#get_create_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Items Jobs Get all catalog item bulk create jobs.
-
#get_create_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Variants Job Get a catalog variant bulk create job with the given job ID.
-
#get_create_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Variants Job Get a catalog variant bulk create job with the given job ID.
-
#get_create_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Variants Jobs Get all catalog variant bulk create jobs.
-
#get_create_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Variants Jobs Get all catalog variant bulk create jobs.
-
#get_delete_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Categories Job Get a catalog category bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`. -
#get_delete_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Categories Job Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`.
-
#get_delete_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Categories Jobs Get all catalog category bulk delete jobs.
-
#get_delete_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Categories Jobs Get all catalog category bulk delete jobs.
-
#get_delete_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Items Job Get a catalog item bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`. -
#get_delete_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Items Job Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`.
-
#get_delete_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Items Jobs Get all catalog item bulk delete jobs.
-
#get_delete_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Items Jobs Get all catalog item bulk delete jobs.
-
#get_delete_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Variants Job Get a catalog variant bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`. -
#get_delete_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Variants Job Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`.
-
#get_delete_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Variants Jobs Get all catalog variant bulk delete jobs.
-
#get_delete_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Variants Jobs Get all catalog variant bulk delete jobs.
-
#get_update_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Categories Job Get a catalog category bulk update job with the given job ID.
-
#get_update_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Categories Job Get a catalog category bulk update job with the given job ID.
-
#get_update_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Categories Jobs Get all catalog category bulk update jobs.
-
#get_update_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Categories Jobs Get all catalog category bulk update jobs.
-
#get_update_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Items Job Get a catalog item bulk update job with the given job ID.
-
#get_update_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Items Job Get a catalog item bulk update job with the given job ID.
-
#get_update_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Items Jobs Get all catalog item bulk update jobs.
-
#get_update_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Items Jobs Get all catalog item bulk update jobs.
-
#get_update_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Variants Job Get a catalog variate bulk update job with the given job ID.
-
#get_update_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Variants Job Get a catalog variate bulk update job with the given job ID.
-
#get_update_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Variants Jobs Get all catalog variant bulk update jobs.
-
#get_update_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Variants Jobs Get all catalog variant bulk update jobs.
-
#initialize(api_client = ApiClient.default) ⇒ CatalogsApi
constructor
A new instance of CatalogsApi.
-
#spawn_create_categories_job(catalog_category_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Categories Job Create a catalog category bulk create job to create a batch of catalog categories.
-
#spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Categories Job Create a catalog category bulk create job to create a batch of catalog categories.
-
#spawn_create_items_job(catalog_item_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Items Job Create a catalog item bulk create job to create a batch of catalog items.
-
#spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Items Job Create a catalog item bulk create job to create a batch of catalog items.
-
#spawn_create_variants_job(catalog_variant_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Variants Job Create a catalog variant bulk create job to create a batch of catalog variants.
-
#spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Variants Job Create a catalog variant bulk create job to create a batch of catalog variants.
-
#spawn_delete_categories_job(catalog_category_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Categories Job Create a catalog category bulk delete job to delete a batch of catalog categories.
-
#spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Categories Job Create a catalog category bulk delete job to delete a batch of catalog categories.
-
#spawn_delete_items_job(catalog_item_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Items Job Create a catalog item bulk delete job to delete a batch of catalog items.
-
#spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Items Job Create a catalog item bulk delete job to delete a batch of catalog items.
-
#spawn_delete_variants_job(catalog_variant_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Variants Job Create a catalog variant bulk delete job to delete a batch of catalog variants.
-
#spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Variants Job Create a catalog variant bulk delete job to delete a batch of catalog variants.
-
#spawn_update_categories_job(catalog_category_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Categories Job Create a catalog category bulk update job to update a batch of catalog categories.
-
#spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Categories Job Create a catalog category bulk update job to update a batch of catalog categories.
-
#spawn_update_items_job(catalog_item_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Items Job Create a catalog item bulk update job to update a batch of catalog items.
-
#spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Items Job Create a catalog item bulk update job to update a batch of catalog items.
-
#spawn_update_variants_job(catalog_variant_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Variants Job Create a catalog variant bulk update job to update a batch of catalog variants.
-
#spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Variants Job Create a catalog variant bulk update job to update a batch of catalog variants.
-
#update_catalog_category(id, catalog_category_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Category Update a catalog category with the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#update_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Update Catalog Category Relationships Items Update item relationships for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Catalog Category Relationships Items Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#update_catalog_category_with_http_info(id, catalog_category_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Category Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#update_catalog_item(id, catalog_item_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Item Update a catalog item with the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#update_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Update Catalog Item Relationships Categories Update catalog category relationships for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Catalog Item Relationships Categories Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Item Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
-
#update_catalog_variant(id, catalog_variant_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Variant Update a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`. -
#update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Variant Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CatalogsApi
Returns a new instance of CatalogsApi.
19 20 21 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_back_in_stock_subscription(server_bis_subscription_create_query, opts = {}) ⇒ nil
Create Back In Stock Subscription Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:write` `profiles:write`
27 28 29 30 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 27 def create_back_in_stock_subscription(server_bis_subscription_create_query, opts = {}) create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts) nil end |
#create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Back In Stock Subscription Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details. This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:write` `profiles:write`
37 38 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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 37 def create_back_in_stock_subscription_with_http_info(server_bis_subscription_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_back_in_stock_subscription ...' end # verify the required parameter 'server_bis_subscription_create_query' is set if @api_client.config.client_side_validation && server_bis_subscription_create_query.nil? fail ArgumentError, "Missing the required parameter 'server_bis_subscription_create_query' when calling CatalogsApi.create_back_in_stock_subscription" end # resource path local_var_path = '/api/back-in-stock-subscriptions/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(server_bis_subscription_create_query) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_back_in_stock_subscription", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_back_in_stock_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_catalog_category(catalog_category_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Category Create a new catalog category.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
97 98 99 100 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 97 def create_catalog_category(catalog_category_create_query, opts = {}) data, _status_code, _headers = create_catalog_category_with_http_info(catalog_category_create_query, opts) data end |
#create_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Create Catalog Category Relationships Items Create a new item relationship for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
168 169 170 171 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 168 def create_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts) nil end |
#create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Catalog Category Relationships Items Create a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 179 def create_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_catalog_category_relationships_items ...' 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 CatalogsApi.create_catalog_category_relationships_items" end # verify the required parameter 'catalog_category_item_op' is set if @api_client.config.client_side_validation && catalog_category_item_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_item_op' when calling CatalogsApi.create_catalog_category_relationships_items" end # resource path local_var_path = '/api/catalog-categories/{id}/relationships/items/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_item_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_catalog_category_relationships_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_catalog_category_relationships_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_catalog_category_with_http_info(catalog_category_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Category Create a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 107 def create_catalog_category_with_http_info(catalog_category_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_catalog_category ...' end # verify the required parameter 'catalog_category_create_query' is set if @api_client.config.client_side_validation && catalog_category_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_create_query' when calling CatalogsApi.create_catalog_category" end # resource path local_var_path = '/api/catalog-categories/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_catalog_category", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_catalog_item(catalog_item_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Item Create a new catalog item.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
243 244 245 246 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 243 def create_catalog_item(catalog_item_create_query, opts = {}) data, _status_code, _headers = create_catalog_item_with_http_info(catalog_item_create_query, opts) data end |
#create_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Create Catalog Item Relationships Categories Create a new catalog category relationship for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
314 315 316 317 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 314 def create_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts) nil end |
#create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Catalog Item Relationships Categories Create a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 325 def create_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_catalog_item_relationships_categories ...' 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 CatalogsApi.create_catalog_item_relationships_categories" end # verify the required parameter 'catalog_item_category_op' is set if @api_client.config.client_side_validation && catalog_item_category_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_category_op' when calling CatalogsApi.create_catalog_item_relationships_categories" end # resource path local_var_path = '/api/catalog-items/{id}/relationships/categories/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_category_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_catalog_item_relationships_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_catalog_item_relationships_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_catalog_item_with_http_info(catalog_item_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Item Create a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 253 def create_catalog_item_with_http_info(catalog_item_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_catalog_item ...' end # verify the required parameter 'catalog_item_create_query' is set if @api_client.config.client_side_validation && catalog_item_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_create_query' when calling CatalogsApi.create_catalog_item" end # resource path local_var_path = '/api/catalog-items/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_catalog_item", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_catalog_variant(catalog_variant_create_query, opts = {}) ⇒ Hash<String, Object>
Create Catalog Variant Create a new variant for a related catalog item.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
389 390 391 392 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 389 def create_catalog_variant(catalog_variant_create_query, opts = {}) data, _status_code, _headers = create_catalog_variant_with_http_info(catalog_variant_create_query, opts) data end |
#create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Catalog Variant Create a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 399 def create_catalog_variant_with_http_info(catalog_variant_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.create_catalog_variant ...' end # verify the required parameter 'catalog_variant_create_query' is set if @api_client.config.client_side_validation && catalog_variant_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_variant_create_query' when calling CatalogsApi.create_catalog_variant" end # resource path local_var_path = '/api/catalog-variants/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_variant_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.create_catalog_variant", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#create_catalog_variant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_catalog_category(id, opts = {}) ⇒ nil
Delete Catalog Category Delete a catalog category using the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
459 460 461 462 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 459 def delete_catalog_category(id, opts = {}) delete_catalog_category_with_http_info(id, opts) nil end |
#delete_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Delete Catalog Category Relationships Items Delete item relationships for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
525 526 527 528 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 525 def delete_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts) nil end |
#delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Category Relationships Items Delete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
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 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 536 def delete_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.delete_catalog_category_relationships_items ...' 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 CatalogsApi.delete_catalog_category_relationships_items" end # verify the required parameter 'catalog_category_item_op' is set if @api_client.config.client_side_validation && catalog_category_item_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_item_op' when calling CatalogsApi.delete_catalog_category_relationships_items" end # resource path local_var_path = '/api/catalog-categories/{id}/relationships/items/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_item_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.delete_catalog_category_relationships_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#delete_catalog_category_relationships_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_catalog_category_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Category Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 469 def delete_catalog_category_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.delete_catalog_category ...' 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 CatalogsApi.delete_catalog_category" end # resource path local_var_path = '/api/catalog-categories/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.delete_catalog_category", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#delete_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_catalog_item(id, opts = {}) ⇒ nil
Delete Catalog Item Delete a catalog item with the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
600 601 602 603 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 600 def delete_catalog_item(id, opts = {}) delete_catalog_item_with_http_info(id, opts) nil end |
#delete_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Delete Catalog Item Relationships Categories Delete catalog category relationships for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
666 667 668 669 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 666 def delete_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts) nil end |
#delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Item Relationships Categories Delete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
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 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 677 def delete_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.delete_catalog_item_relationships_categories ...' 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 CatalogsApi.delete_catalog_item_relationships_categories" end # verify the required parameter 'catalog_item_category_op' is set if @api_client.config.client_side_validation && catalog_item_category_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_category_op' when calling CatalogsApi.delete_catalog_item_relationships_categories" end # resource path local_var_path = '/api/catalog-items/{id}/relationships/categories/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_category_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.delete_catalog_item_relationships_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#delete_catalog_item_relationships_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_catalog_item_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Item Delete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
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 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 610 def delete_catalog_item_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.delete_catalog_item ...' 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 CatalogsApi.delete_catalog_item" end # resource path local_var_path = '/api/catalog-items/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.delete_catalog_item", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#delete_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_catalog_variant(id, opts = {}) ⇒ nil
Delete Catalog Variant Delete a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
741 742 743 744 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 741 def delete_catalog_variant(id, opts = {}) delete_catalog_variant_with_http_info(id, opts) nil end |
#delete_catalog_variant_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Catalog Variant Delete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 751 def delete_catalog_variant_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.delete_catalog_variant ...' 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 CatalogsApi.delete_catalog_variant" end # resource path local_var_path = '/api/catalog-variants/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.delete_catalog_variant", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#delete_catalog_variant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_categories(opts = {}) ⇒ Hash<String, Object>
Get Catalog Categories Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: ‘created` Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
809 810 811 812 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 809 def get_catalog_categories(opts = {}) data, _status_code, _headers = get_catalog_categories_with_http_info(opts) data end |
#get_catalog_categories_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Categories Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
822 823 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 873 874 875 876 877 878 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 822 def get_catalog_categories_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_categories ...' end allowable_values = ["external_id", "name", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}" end allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-categories/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_category(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Get a catalog category with the given category ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
886 887 888 889 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 886 def get_catalog_category(id, opts = {}) data, _status_code, _headers = get_catalog_category_with_http_info(id, opts) data end |
#get_catalog_category_items(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Items Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: ‘created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
963 964 965 966 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 963 def get_catalog_category_items(id, opts = {}) data, _status_code, _headers = get_catalog_category_items_with_http_info(id, opts) data end |
#get_catalog_category_items_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Items Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
979 980 981 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 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 979 def get_catalog_category_items_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_category_items ...' 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 CatalogsApi.get_catalog_category_items" end allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["variants"] 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 allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-categories/{id}/items/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil? query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].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? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_category_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_category_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_category_relationships_items(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Category Relationships Items Get all items in the given category ID. Returns a maximum of 100 items per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1057 1058 1059 1060 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1057 def get_catalog_category_relationships_items(id, opts = {}) data, _status_code, _headers = get_catalog_category_relationships_items_with_http_info(id, opts) data end |
#get_catalog_category_relationships_items_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Relationships Items Get all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1068 def get_catalog_category_relationships_items_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_category_relationships_items ...' 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 CatalogsApi.get_catalog_category_relationships_items" end # resource path local_var_path = '/api/catalog-categories/{id}/relationships/items/'.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? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_category_relationships_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_category_relationships_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_category_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Category Get a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 897 def get_catalog_category_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_category ...' 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 CatalogsApi.get_catalog_category" end allowable_values = ["external_id", "name", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-categories/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_category", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_item(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: ‘variants`
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1127 1128 1129 1130 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1127 def get_catalog_item(id, opts = {}) data, _status_code, _headers = get_catalog_item_with_http_info(id, opts) data end |
#get_catalog_item_categories(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Categories Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: ‘created` Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1214 1215 1216 1217 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1214 def get_catalog_item_categories(id, opts = {}) data, _status_code, _headers = get_catalog_item_categories_with_http_info(id, opts) data end |
#get_catalog_item_categories_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Categories Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1228 def get_catalog_item_categories_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item_categories ...' 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 CatalogsApi.get_catalog_item_categories" end allowable_values = ["external_id", "name", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}" end allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-items/{id}/categories/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_item_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_item_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_item_relationships_categories(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Relationships Categories Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1296 1297 1298 1299 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1296 def get_catalog_item_relationships_categories(id, opts = {}) data, _status_code, _headers = get_catalog_item_relationships_categories_with_http_info(id, opts) data end |
#get_catalog_item_relationships_categories_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Relationships Categories Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1307 def get_catalog_item_relationships_categories_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item_relationships_categories ...' 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 CatalogsApi.get_catalog_item_relationships_categories" end # resource path local_var_path = '/api/catalog-items/{id}/relationships/categories/'.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? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_item_relationships_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_item_relationships_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_item_variants(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Item Variants Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: ‘created` Returns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1367 1368 1369 1370 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1367 def get_catalog_item_variants(id, opts = {}) data, _status_code, _headers = get_catalog_item_variants_with_http_info(id, opts) data end |
#get_catalog_item_variants_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Variants Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1381 def get_catalog_item_variants_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item_variants ...' 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 CatalogsApi.get_catalog_item_variants" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-items/{id}/variants/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_item_variants", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_item_variants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_item_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Item Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: `variants`<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1140 def get_catalog_item_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_item ...' 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 CatalogsApi.get_catalog_item" end allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["variants"] 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/catalog-items/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil? query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_item", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_items(opts = {}) ⇒ Hash<String, Object>
Get Catalog Items Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: ‘created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1453 1454 1455 1456 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1453 def get_catalog_items(opts = {}) data, _status_code, _headers = get_catalog_items_with_http_info(opts) data end |
#get_catalog_items_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Items Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and descending order: `created` Include parameters can be provided to get the following related resource data: `variants` Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1468 def get_catalog_items_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_items ...' end allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["variants"] 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 allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-items/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].nil? query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].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? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_variant(id, opts = {}) ⇒ Hash<String, Object>
Get Catalog Variant Get a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1542 1543 1544 1545 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1542 def get_catalog_variant(id, opts = {}) data, _status_code, _headers = get_catalog_variant_with_http_info(id, opts) data end |
#get_catalog_variant_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Variant Get a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1553 def get_catalog_variant_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_variant ...' 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 CatalogsApi.get_catalog_variant" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variants/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_variant", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_variant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_catalog_variants(opts = {}) ⇒ Hash<String, Object>
Get Catalog Variants Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: ‘created` Returns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1616 1617 1618 1619 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1616 def get_catalog_variants(opts = {}) data, _status_code, _headers = get_catalog_variants_with_http_info(opts) data end |
#get_catalog_variants_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Catalog Variants Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order: `created` Returns a maximum of 100 variants per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1629 def get_catalog_variants_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_catalog_variants ...' end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["created", "-created"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variants/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_catalog_variants", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_catalog_variants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Categories Job Get a catalog category bulk create job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `categories`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1695 1696 1697 1698 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1695 def get_create_categories_job(job_id, opts = {}) data, _status_code, _headers = get_create_categories_job_with_http_info(job_id, opts) data end |
#get_create_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Categories Job Get a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1708 def get_create_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_categories_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_create_categories_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "name", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}" end allowable_values = ["categories"] 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/catalog-category-bulk-create-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_create_job'], :csv) if !opts[:'fields_catalog_category_bulk_create_job'].nil? query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Categories Jobs Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1780 1781 1782 1783 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1780 def get_create_categories_jobs(opts = {}) data, _status_code, _headers = get_create_categories_jobs_with_http_info(opts) data end |
#get_create_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Categories Jobs Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1792 def get_create_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_categories_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_create_job'] && !opts[:'fields_catalog_category_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_create_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-category-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_create_job'], :csv) if !opts[:'fields_catalog_category_bulk_create_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_categories_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Items Job Get a catalog item bulk create job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `items`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1853 1854 1855 1856 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1853 def get_create_items_job(job_id, opts = {}) data, _status_code, _headers = get_create_items_job_with_http_info(job_id, opts) data end |
#get_create_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Items Job Get a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1928 1929 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1866 def get_create_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_items_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_create_items_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}" end allowable_values = ["items"] 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/catalog-item-bulk-create-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_create_job'], :csv) if !opts[:'fields_catalog_item_bulk_create_job'].nil? query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Items Jobs Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
1938 1939 1940 1941 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1938 def get_create_items_jobs(opts = {}) data, _status_code, _headers = get_create_items_jobs_with_http_info(opts) data end |
#get_create_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Items Jobs Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 1999 2000 2001 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 1950 def get_create_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_items_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_create_job'] && !opts[:'fields_catalog_item_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_create_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-item-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_create_job'], :csv) if !opts[:'fields_catalog_item_bulk_create_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_items_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_items_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Create Variants Job Get a catalog variant bulk create job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `variants`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2011 2012 2013 2014 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2011 def get_create_variants_job(job_id, opts = {}) data, _status_code, _headers = get_create_variants_job_with_http_info(job_id, opts) data end |
#get_create_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Variants Job Get a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2024 2025 2026 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/catalogs_api.rb', line 2024 def get_create_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_variants_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_create_variants_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["variants"] 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/catalog-variant-bulk-create-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_create_job'], :csv) if !opts[:'fields_catalog_variant_bulk_create_job'].nil? query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_create_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Create Variants Jobs Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2096 2097 2098 2099 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2096 def get_create_variants_jobs(opts = {}) data, _status_code, _headers = get_create_variants_jobs_with_http_info(opts) data end |
#get_create_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Create Variants Jobs Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2108 2109 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 2159 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2108 def get_create_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_create_variants_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_create_job'] && !opts[:'fields_catalog_variant_bulk_create_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_create_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variant-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-create-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_create_job'], :csv) if !opts[:'fields_catalog_variant_bulk_create_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_create_variants_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_create_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Categories Job Get a catalog category bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2167 2168 2169 2170 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2167 def get_delete_categories_job(job_id, opts = {}) data, _status_code, _headers = get_delete_categories_job_with_http_info(job_id, opts) data end |
#get_delete_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Categories Job Get a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2178 2179 2180 2181 2182 2183 2184 2185 2186 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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2178 def get_delete_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_categories_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_delete_categories_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-category-bulk-delete-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_delete_job'], :csv) if !opts[:'fields_catalog_category_bulk_delete_job'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Categories Jobs Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2240 2241 2242 2243 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2240 def get_delete_categories_jobs(opts = {}) data, _status_code, _headers = get_delete_categories_jobs_with_http_info(opts) data end |
#get_delete_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Categories Jobs Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2252 def get_delete_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_categories_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_delete_job'] && !opts[:'fields_catalog_category_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-category-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_delete_job'], :csv) if !opts[:'fields_catalog_category_bulk_delete_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_categories_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Items Job Get a catalog item bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2311 2312 2313 2314 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2311 def get_delete_items_job(job_id, opts = {}) data, _status_code, _headers = get_delete_items_job_with_http_info(job_id, opts) data end |
#get_delete_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Items Job Get a catalog item bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2322 def get_delete_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_items_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_delete_items_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-item-bulk-delete-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_delete_job'], :csv) if !opts[:'fields_catalog_item_bulk_delete_job'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Items Jobs Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2384 2385 2386 2387 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2384 def get_delete_items_jobs(opts = {}) data, _status_code, _headers = get_delete_items_jobs_with_http_info(opts) data end |
#get_delete_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Items Jobs Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2396 def get_delete_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_items_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_delete_job'] && !opts[:'fields_catalog_item_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-item-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_delete_job'], :csv) if !opts[:'fields_catalog_item_bulk_delete_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_items_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_items_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Delete Variants Job Get a catalog variant bulk delete job with the given job ID.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2455 2456 2457 2458 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2455 def get_delete_variants_job(job_id, opts = {}) data, _status_code, _headers = get_delete_variants_job_with_http_info(job_id, opts) data end |
#get_delete_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Variants Job Get a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2466 def get_delete_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_variants_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_delete_variants_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variant-bulk-delete-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_delete_job'], :csv) if !opts[:'fields_catalog_variant_bulk_delete_job'].nil? # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_delete_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Delete Variants Jobs Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2528 2529 2530 2531 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2528 def get_delete_variants_jobs(opts = {}) data, _status_code, _headers = get_delete_variants_jobs_with_http_info(opts) data end |
#get_delete_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Delete Variants Jobs Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2540 def get_delete_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_delete_variants_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_delete_job'] && !opts[:'fields_catalog_variant_bulk_delete_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_delete_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variant-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-delete-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_delete_job'], :csv) if !opts[:'fields_catalog_variant_bulk_delete_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_delete_variants_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_delete_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_categories_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Categories Job Get a catalog category bulk update job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `categories`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2601 2602 2603 2604 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2601 def get_update_categories_job(job_id, opts = {}) data, _status_code, _headers = get_update_categories_job_with_http_info(job_id, opts) data end |
#get_update_categories_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Categories Job Get a catalog category bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2614 def get_update_categories_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_categories_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_update_categories_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "name", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category'] && !opts[:'fields_catalog_category'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category\", must include one of #{allowable_values}" end allowable_values = ["categories"] 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/catalog-category-bulk-update-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil? query_params[:'fields[catalog-category]'] = @api_client.build_collection_param(opts[:'fields_catalog_category'], :csv) if !opts[:'fields_catalog_category'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_categories_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Categories Jobs Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2686 2687 2688 2689 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2686 def get_update_categories_jobs(opts = {}) data, _status_code, _headers = get_update_categories_jobs_with_http_info(opts) data end |
#get_update_categories_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Categories Jobs Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2698 def get_update_categories_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_categories_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_category_bulk_update_job'] && !opts[:'fields_catalog_category_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_category_bulk_update_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-category-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-category-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_category_bulk_update_job'], :csv) if !opts[:'fields_catalog_category_bulk_update_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_categories_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_categories_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_items_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Items Job Get a catalog item bulk update job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `items`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2759 2760 2761 2762 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2759 def get_update_items_job(job_id, opts = {}) data, _status_code, _headers = get_update_items_job_with_http_info(job_id, opts) data end |
#get_update_items_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Items Job Get a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 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 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2772 def get_update_items_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_items_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_update_items_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item'] && !opts[:'fields_catalog_item'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item\", must include one of #{allowable_values}" end allowable_values = ["items"] 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/catalog-item-bulk-update-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_update_job'], :csv) if !opts[:'fields_catalog_item_bulk_update_job'].nil? query_params[:'fields[catalog-item]'] = @api_client.build_collection_param(opts[:'fields_catalog_item'], :csv) if !opts[:'fields_catalog_item'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_items_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Items Jobs Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2844 2845 2846 2847 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2844 def get_update_items_jobs(opts = {}) data, _status_code, _headers = get_update_items_jobs_with_http_info(opts) data end |
#get_update_items_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Items Jobs Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2856 def get_update_items_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_items_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_item_bulk_update_job'] && !opts[:'fields_catalog_item_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_item_bulk_update_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-item-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-item-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_item_bulk_update_job'], :csv) if !opts[:'fields_catalog_item_bulk_update_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_items_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_items_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_variants_job(job_id, opts = {}) ⇒ Hash<String, Object>
Get Update Variants Job Get a catalog variate bulk update job with the given job ID. An ‘include` parameter can be provided to get the following related resource data: `variants`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m` Scopes: `catalogs:read`
2917 2918 2919 2920 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2917 def get_update_variants_job(job_id, opts = {}) data, _status_code, _headers = get_update_variants_job_with_http_info(job_id, opts) data end |
#get_update_variants_job_with_http_info(job_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Variants Job Get a catalog variate bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 2930 def get_update_variants_job_with_http_info(job_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_variants_job ...' end # verify the required parameter 'job_id' is set if @api_client.config.client_side_validation && job_id.nil? fail ArgumentError, "Missing the required parameter 'job_id' when calling CatalogsApi.get_update_variants_job" end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}" end allowable_values = ["external_id", "title", "description", "sku", "inventory_policy", "inventory_quantity", "price", "url", "image_full_url", "image_thumbnail_url", "images", "custom_metadata", "published", "created", "updated"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant'] && !opts[:'fields_catalog_variant'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant\", must include one of #{allowable_values}" end allowable_values = ["variants"] 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/catalog-variant-bulk-update-jobs/{job_id}/'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_update_job'], :csv) if !opts[:'fields_catalog_variant_bulk_update_job'].nil? query_params[:'fields[catalog-variant]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant'], :csv) if !opts[:'fields_catalog_variant'].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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_update_variants_jobs(opts = {}) ⇒ Hash<String, Object>
Get Update Variants Jobs Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.
*Rate limits*:
Burst: ‘350/s`
Steady: `3500/m` Scopes: `catalogs:read`
3002 3003 3004 3005 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3002 def get_update_variants_jobs(opts = {}) data, _status_code, _headers = get_update_variants_jobs_with_http_info(opts) data end |
#get_update_variants_jobs_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Update Variants Jobs Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` Scopes: `catalogs:read`
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 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3014 def get_update_variants_jobs_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.get_update_variants_jobs ...' end allowable_values = ["job_id", "status", "created_at", "total_count", "completed_count", "failed_count", "completed_at", "errors", "expires_at"] if @api_client.config.client_side_validation && opts[:'fields_catalog_variant_bulk_update_job'] && !opts[:'fields_catalog_variant_bulk_update_job'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_catalog_variant_bulk_update_job\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/catalog-variant-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[catalog-variant-bulk-update-job]'] = @api_client.build_collection_param(opts[:'fields_catalog_variant_bulk_update_job'], :csv) if !opts[:'fields_catalog_variant_bulk_update_job'].nil? 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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.get_update_variants_jobs", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#get_update_variants_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_create_categories_job(catalog_category_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Categories Job Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3072 3073 3074 3075 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3072 def spawn_create_categories_job(catalog_category_create_job_create_query, opts = {}) data, _status_code, _headers = spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query, opts) data end |
#spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Categories Job Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
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 3131 3132 3133 3134 3135 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3082 def spawn_create_categories_job_with_http_info(catalog_category_create_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_create_categories_job ...' end # verify the required parameter 'catalog_category_create_job_create_query' is set if @api_client.config.client_side_validation && catalog_category_create_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_create_job_create_query' when calling CatalogsApi.spawn_create_categories_job" end # resource path local_var_path = '/api/catalog-category-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_create_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_create_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_create_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_create_items_job(catalog_item_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Items Job Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3142 3143 3144 3145 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3142 def spawn_create_items_job(catalog_item_create_job_create_query, opts = {}) data, _status_code, _headers = spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, opts) data end |
#spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Items Job Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3152 def spawn_create_items_job_with_http_info(catalog_item_create_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_create_items_job ...' end # verify the required parameter 'catalog_item_create_job_create_query' is set if @api_client.config.client_side_validation && catalog_item_create_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_create_job_create_query' when calling CatalogsApi.spawn_create_items_job" end # resource path local_var_path = '/api/catalog-item-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_create_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_create_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_create_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_create_variants_job(catalog_variant_create_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Create Variants Job Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3212 3213 3214 3215 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3212 def spawn_create_variants_job(catalog_variant_create_job_create_query, opts = {}) data, _status_code, _headers = spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query, opts) data end |
#spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Create Variants Job Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3222 def spawn_create_variants_job_with_http_info(catalog_variant_create_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_create_variants_job ...' end # verify the required parameter 'catalog_variant_create_job_create_query' is set if @api_client.config.client_side_validation && catalog_variant_create_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_variant_create_job_create_query' when calling CatalogsApi.spawn_create_variants_job" end # resource path local_var_path = '/api/catalog-variant-bulk-create-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_variant_create_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_create_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_create_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_delete_categories_job(catalog_category_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Categories Job Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3282 3283 3284 3285 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3282 def spawn_delete_categories_job(catalog_category_delete_job_create_query, opts = {}) data, _status_code, _headers = spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query, opts) data end |
#spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Categories Job Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3292 def spawn_delete_categories_job_with_http_info(catalog_category_delete_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_delete_categories_job ...' end # verify the required parameter 'catalog_category_delete_job_create_query' is set if @api_client.config.client_side_validation && catalog_category_delete_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_delete_job_create_query' when calling CatalogsApi.spawn_delete_categories_job" end # resource path local_var_path = '/api/catalog-category-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_delete_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_delete_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_delete_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_delete_items_job(catalog_item_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Items Job Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3352 3353 3354 3355 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3352 def spawn_delete_items_job(catalog_item_delete_job_create_query, opts = {}) data, _status_code, _headers = spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, opts) data end |
#spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Items Job Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3362 def spawn_delete_items_job_with_http_info(catalog_item_delete_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_delete_items_job ...' end # verify the required parameter 'catalog_item_delete_job_create_query' is set if @api_client.config.client_side_validation && catalog_item_delete_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_delete_job_create_query' when calling CatalogsApi.spawn_delete_items_job" end # resource path local_var_path = '/api/catalog-item-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_delete_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_delete_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_delete_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_delete_variants_job(catalog_variant_delete_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Delete Variants Job Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3422 3423 3424 3425 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3422 def spawn_delete_variants_job(catalog_variant_delete_job_create_query, opts = {}) data, _status_code, _headers = spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query, opts) data end |
#spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Delete Variants Job Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3432 def spawn_delete_variants_job_with_http_info(catalog_variant_delete_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_delete_variants_job ...' end # verify the required parameter 'catalog_variant_delete_job_create_query' is set if @api_client.config.client_side_validation && catalog_variant_delete_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_variant_delete_job_create_query' when calling CatalogsApi.spawn_delete_variants_job" end # resource path local_var_path = '/api/catalog-variant-bulk-delete-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_variant_delete_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_delete_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_delete_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_update_categories_job(catalog_category_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Categories Job Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3492 3493 3494 3495 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3492 def spawn_update_categories_job(catalog_category_update_job_create_query, opts = {}) data, _status_code, _headers = spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query, opts) data end |
#spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Categories Job Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog categories per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3502 def spawn_update_categories_job_with_http_info(catalog_category_update_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_update_categories_job ...' end # verify the required parameter 'catalog_category_update_job_create_query' is set if @api_client.config.client_side_validation && catalog_category_update_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_update_job_create_query' when calling CatalogsApi.spawn_update_categories_job" end # resource path local_var_path = '/api/catalog-category-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_update_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_update_categories_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_update_categories_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_update_items_job(catalog_item_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Items Job Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3562 3563 3564 3565 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3562 def spawn_update_items_job(catalog_item_update_job_create_query, opts = {}) data, _status_code, _headers = spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, opts) data end |
#spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Items Job Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3572 def spawn_update_items_job_with_http_info(catalog_item_update_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_update_items_job ...' end # verify the required parameter 'catalog_item_update_job_create_query' is set if @api_client.config.client_side_validation && catalog_item_update_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_update_job_create_query' when calling CatalogsApi.spawn_update_items_job" end # resource path local_var_path = '/api/catalog-item-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_update_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_update_items_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_update_items_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#spawn_update_variants_job(catalog_variant_update_job_create_query, opts = {}) ⇒ Hash<String, Object>
Spawn Update Variants Job Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3632 3633 3634 3635 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3632 def spawn_update_variants_job(catalog_variant_update_job_create_query, opts = {}) data, _status_code, _headers = spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query, opts) data end |
#spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Spawn Update Variants Job Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants per request. The maximum allowed payload size is 4MB.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3642 def spawn_update_variants_job_with_http_info(catalog_variant_update_job_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.spawn_update_variants_job ...' end # verify the required parameter 'catalog_variant_update_job_create_query' is set if @api_client.config.client_side_validation && catalog_variant_update_job_create_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_variant_update_job_create_query' when calling CatalogsApi.spawn_update_variants_job" end # resource path local_var_path = '/api/catalog-variant-bulk-update-jobs/' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # klaviyo api revision header_params['revision'] = ENV['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_variant_update_job_create_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.spawn_update_variants_job", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#spawn_update_variants_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_catalog_category(id, catalog_category_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Category Update a catalog category with the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3703 3704 3705 3706 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3703 def update_catalog_category(id, catalog_category_update_query, opts = {}) data, _status_code, _headers = update_catalog_category_with_http_info(id, catalog_category_update_query, opts) data end |
#update_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) ⇒ nil
Update Catalog Category Relationships Items Update item relationships for the given category ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3779 3780 3781 3782 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3779 def update_catalog_category_relationships_items(id, catalog_category_item_op, opts = {}) update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts) nil end |
#update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Catalog Category Relationships Items Update item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3790 def update_catalog_category_relationships_items_with_http_info(id, catalog_category_item_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.update_catalog_category_relationships_items ...' 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 CatalogsApi.update_catalog_category_relationships_items" end # verify the required parameter 'catalog_category_item_op' is set if @api_client.config.client_side_validation && catalog_category_item_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_item_op' when calling CatalogsApi.update_catalog_category_relationships_items" end # resource path local_var_path = '/api/catalog-categories/{id}/relationships/items/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_item_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.update_catalog_category_relationships_items", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#update_catalog_category_relationships_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_catalog_category_with_http_info(id, catalog_category_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Category Update a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3714 def update_catalog_category_with_http_info(id, catalog_category_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.update_catalog_category ...' 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 CatalogsApi.update_catalog_category" end # verify the required parameter 'catalog_category_update_query' is set if @api_client.config.client_side_validation && catalog_category_update_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_category_update_query' when calling CatalogsApi.update_catalog_category" end # resource path local_var_path = '/api/catalog-categories/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_category_update_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.update_catalog_category", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#update_catalog_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_catalog_item(id, catalog_item_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Item Update a catalog item with the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3855 3856 3857 3858 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3855 def update_catalog_item(id, catalog_item_update_query, opts = {}) data, _status_code, _headers = update_catalog_item_with_http_info(id, catalog_item_update_query, opts) data end |
#update_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) ⇒ nil
Update Catalog Item Relationships Categories Update catalog category relationships for the given item ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
3931 3932 3933 3934 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3931 def update_catalog_item_relationships_categories(id, catalog_item_category_op, opts = {}) update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts) nil end |
#update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Catalog Item Relationships Categories Update catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3942 def update_catalog_item_relationships_categories_with_http_info(id, catalog_item_category_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.update_catalog_item_relationships_categories ...' 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 CatalogsApi.update_catalog_item_relationships_categories" end # verify the required parameter 'catalog_item_category_op' is set if @api_client.config.client_side_validation && catalog_item_category_op.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_category_op' when calling CatalogsApi.update_catalog_item_relationships_categories" end # resource path local_var_path = '/api/catalog-items/{id}/relationships/categories/'.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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_category_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.update_catalog_item_relationships_categories", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#update_catalog_item_relationships_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Item Update a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 3866 def update_catalog_item_with_http_info(id, catalog_item_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.update_catalog_item ...' 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 CatalogsApi.update_catalog_item" end # verify the required parameter 'catalog_item_update_query' is set if @api_client.config.client_side_validation && catalog_item_update_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_item_update_query' when calling CatalogsApi.update_catalog_item" end # resource path local_var_path = '/api/catalog-items/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_item_update_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.update_catalog_item", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#update_catalog_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_catalog_variant(id, catalog_variant_update_query, opts = {}) ⇒ Hash<String, Object>
Update Catalog Variant Update a catalog item variant with the given variant ID.
*Rate limits*:
Burst: ‘75/s`
Steady: `700/m` Scopes: `catalogs:write`
4007 4008 4009 4010 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 4007 def update_catalog_variant(id, catalog_variant_update_query, opts = {}) data, _status_code, _headers = update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts) data end |
#update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Catalog Variant Update a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` Scopes: `catalogs:write`
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 |
# File 'lib/klaviyo-api-sdk/api/catalogs_api.rb', line 4018 def update_catalog_variant_with_http_info(id, catalog_variant_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CatalogsApi.update_catalog_variant ...' 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 CatalogsApi.update_catalog_variant" end # verify the required parameter 'catalog_variant_update_query' is set if @api_client.config.client_side_validation && catalog_variant_update_query.nil? fail ArgumentError, "Missing the required parameter 'catalog_variant_update_query' when calling CatalogsApi.update_catalog_variant" end # resource path local_var_path = '/api/catalog-variants/{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['API_REVISION'] || "2023-08-15" # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(catalog_variant_update_query) # return_type return_type = opts[:debug_return_type] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"CatalogsApi.update_catalog_variant", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: CatalogsApi#update_catalog_variant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |