Class: KlaviyoAPI::TagsApi
- Inherits:
-
Object
- Object
- KlaviyoAPI::TagsApi
- Defined in:
- lib/klaviyo-api-sdk/api/tags_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_tag(tag_create_query, opts = {}) ⇒ Hash<String, Object>
Create Tag Create a tag.
-
#create_tag_group(tag_group_create_query, opts = {}) ⇒ Hash<String, Object>
Create Tag Group Create a tag group.
-
#create_tag_group_with_http_info(tag_group_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Tag Group Create a tag group.
-
#create_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil
Create Tag Relationships Campaigns Associate a tag with one or more campaigns.
-
#create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Campaigns Associate a tag with one or more campaigns.
-
#create_tag_relationships_flows(id, tag_flow_op, opts = {}) ⇒ nil
Create Tag Relationships Flows Associate a tag with one or more flows.
-
#create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Flows Associate a tag with one or more flows.
-
#create_tag_relationships_lists(id, tag_list_op, opts = {}) ⇒ nil
Create Tag Relationships Lists Associate a tag with one or more lists.
-
#create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Lists Associate a tag with one or more lists.
-
#create_tag_relationships_segments(id, tag_segment_op, opts = {}) ⇒ nil
Create Tag Relationships Segments Associate a tag with one or more segments.
-
#create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Segments Associate a tag with one or more segments.
-
#create_tag_with_http_info(tag_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Tag Create a tag.
-
#delete_tag(id, opts = {}) ⇒ nil
Delete Tag Delete the tag with the given tag ID.
-
#delete_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Delete Tag Group Delete the tag group with the given tag group ID.
-
#delete_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Delete Tag Group Delete the tag group with the given tag group ID.
-
#delete_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil
Delete Tag Relationships Campaigns Remove a tag’s association with one or more campaigns.
-
#delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Campaigns Remove a tag's association with one or more campaigns.
-
#delete_tag_relationships_flows(id, tag_flow_op, opts = {}) ⇒ nil
Delete Tag Relationships Flows Remove a tag’s association with one or more flows.
-
#delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Flows Remove a tag's association with one or more flows.
-
#delete_tag_relationships_lists(id, tag_list_op, opts = {}) ⇒ nil
Delete Tag Relationships Lists Remove a tag’s association with one or more lists.
-
#delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Lists Remove a tag's association with one or more lists.
-
#delete_tag_relationships_segments(id, tag_segment_op, opts = {}) ⇒ nil
Delete Tag Relationships Segments Remove a tag’s association with one or more segments.
-
#delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Segments Remove a tag's association with one or more segments.
-
#delete_tag_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Delete the tag with the given tag ID.
-
#get_tag(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Retrieve the tag with the given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Retrieve the tag group with the given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_group_relationships_tags(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Relationships Tags Returns the tag IDs of all tags inside the given tag group.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_group_relationships_tags_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Relationships Tags Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tag_group_tags(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Tags Return the tags for a given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_group_tags_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Tags Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tag_groups(opts = {}) ⇒ Hash<String, Object>
Get Tag Groups List all tag groups in an account.
-
#get_tag_groups_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Groups List all tag groups in an account.
-
#get_tag_relationships_campaigns(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Campaigns Returns the IDs of all campaigns associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`. -
#get_tag_relationships_campaigns_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Campaigns Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`.
-
#get_tag_relationships_flows(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Flows Returns the IDs of all flows associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:read` `tags:read`. -
#get_tag_relationships_flows_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Flows Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `flows:read` `tags:read`.
-
#get_tag_relationships_lists(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Lists Returns the IDs of all lists associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `list:read` `tags:read`. -
#get_tag_relationships_lists_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Lists Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `list:read` `tags:read`.
-
#get_tag_relationships_segments(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Segments Returns the IDs of all segments associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:read` `tags:read`. -
#get_tag_relationships_segments_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Segments Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `segments:read` `tags:read`.
-
#get_tag_relationships_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Tag Group Returns the id of the tag group related to the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_relationships_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Tag Group Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tag_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Tag Group Returns the tag group resource for a given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`. -
#get_tag_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Tag Group Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`.
-
#get_tags(opts = {}) ⇒ Hash<String, Object>
Get Tags List all tags in an account.
-
#get_tags_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tags List all tags in an account.
-
#initialize(api_client = ApiClient.default) ⇒ TagsApi
constructor
A new instance of TagsApi.
-
#update_tag(id, tag_update_query, opts = {}) ⇒ nil
Update Tag Update the tag with the given tag ID.
-
#update_tag_group(id, tag_group_update_query, opts = {}) ⇒ Hash<String, Object>
Update Tag Group Update the tag group with the given tag group ID.
-
#update_tag_group_with_http_info(id, tag_group_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Tag Group Update the tag group with the given tag group ID.
-
#update_tag_with_http_info(id, tag_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Tag Update the tag with the given tag ID.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_tag(tag_create_query, opts = {}) ⇒ Hash<String, Object>
Create Tag Create a tag. An account cannot have more than 500 unique tags. A tag belongs to a single tag group. If the ‘tag_group_id` is not specified, the tag is added to the account’s default tag group.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
27 28 29 30 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 27 def create_tag(tag_create_query, opts = {}) data, _status_code, _headers = create_tag_with_http_info(tag_create_query, opts) data end |
#create_tag_group(tag_group_create_query, opts = {}) ⇒ Hash<String, Object>
Create Tag Group Create a tag group. An account cannot have more than 50 unique tag groups. If ‘exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
97 98 99 100 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 97 def create_tag_group(tag_group_create_query, opts = {}) data, _status_code, _headers = create_tag_group_with_http_info(tag_group_create_query, opts) data end |
#create_tag_group_with_http_info(tag_group_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Tag Group Create a tag group. An account cannot have more than 50 unique tag groups. If `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive. If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags: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/tags_api.rb', line 107 def create_tag_group_with_http_info(tag_group_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_group ...' end # verify the required parameter 'tag_group_create_query' is set if @api_client.config.client_side_validation && tag_group_create_query.nil? fail ArgumentError, "Missing the required parameter 'tag_group_create_query' when calling TagsApi.create_tag_group" end # resource path local_var_path = '/api/tag-groups/' # 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(tag_group_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 => :"TagsApi.create_tag_group", :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: TagsApi#create_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil
Create Tag Relationships Campaigns Associate a tag with one or more campaigns. Any campaign cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:write` `tags:write`
168 169 170 171 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 168 def create_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts) nil end |
#create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Campaigns Associate a tag with one or more campaigns. Any campaign cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:write` `tags: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/tags_api.rb', line 179 def create_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_campaigns ...' 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 TagsApi.create_tag_relationships_campaigns" end # verify the required parameter 'tag_campaign_op' is set if @api_client.config.client_side_validation && tag_campaign_op.nil? fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.create_tag_relationships_campaigns" end # resource path local_var_path = '/api/tags/{id}/relationships/campaigns/'.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(tag_campaign_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.create_tag_relationships_campaigns", :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: TagsApi#create_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag_relationships_flows(id, tag_flow_op, opts = {}) ⇒ nil
Create Tag Relationships Flows Associate a tag with one or more flows. Any flow cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:write` `tags:write`
244 245 246 247 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 244 def create_tag_relationships_flows(id, tag_flow_op, opts = {}) create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts) nil end |
#create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Flows Associate a tag with one or more flows. Any flow cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `flows:write` `tags:write`
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 307 308 309 310 311 312 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 255 def create_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_flows ...' 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 TagsApi.create_tag_relationships_flows" end # verify the required parameter 'tag_flow_op' is set if @api_client.config.client_side_validation && tag_flow_op.nil? fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.create_tag_relationships_flows" end # resource path local_var_path = '/api/tags/{id}/relationships/flows/'.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(tag_flow_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.create_tag_relationships_flows", :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: TagsApi#create_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag_relationships_lists(id, tag_list_op, opts = {}) ⇒ nil
Create Tag Relationships Lists Associate a tag with one or more lists. Any list cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `list:write` `tags:write`
320 321 322 323 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 320 def create_tag_relationships_lists(id, tag_list_op, opts = {}) create_tag_relationships_lists_with_http_info(id, tag_list_op, opts) nil end |
#create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Lists Associate a tag with one or more lists. Any list cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `list:write` `tags:write`
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 383 384 385 386 387 388 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 331 def create_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_lists ...' 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 TagsApi.create_tag_relationships_lists" end # verify the required parameter 'tag_list_op' is set if @api_client.config.client_side_validation && tag_list_op.nil? fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.create_tag_relationships_lists" end # resource path local_var_path = '/api/tags/{id}/relationships/lists/'.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(tag_list_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.create_tag_relationships_lists", :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: TagsApi#create_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag_relationships_segments(id, tag_segment_op, opts = {}) ⇒ nil
Create Tag Relationships Segments Associate a tag with one or more segments. Any segment cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:write` `tags:write`
396 397 398 399 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 396 def create_tag_relationships_segments(id, tag_segment_op, opts = {}) create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts) nil end |
#create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Create Tag Relationships Segments Associate a tag with one or more segments. Any segment cannot be associated with more than 100 tags. Use the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `segments:write` `tags:write`
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 407 def create_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag_relationships_segments ...' 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 TagsApi.create_tag_relationships_segments" end # verify the required parameter 'tag_segment_op' is set if @api_client.config.client_side_validation && tag_segment_op.nil? fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.create_tag_relationships_segments" end # resource path local_var_path = '/api/tags/{id}/relationships/segments/'.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(tag_segment_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.create_tag_relationships_segments", :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: TagsApi#create_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_tag_with_http_info(tag_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Create Tag Create a tag. An account cannot have more than 500 unique tags. A tag belongs to a single tag group. If the `tag_group_id` is not specified, the tag is added to the account's default tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags: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/tags_api.rb', line 37 def create_tag_with_http_info(tag_create_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.create_tag ...' end # verify the required parameter 'tag_create_query' is set if @api_client.config.client_side_validation && tag_create_query.nil? fail ArgumentError, "Missing the required parameter 'tag_create_query' when calling TagsApi.create_tag" end # resource path local_var_path = '/api/tags/' # 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(tag_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 => :"TagsApi.create_tag", :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: TagsApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag(id, opts = {}) ⇒ nil
Delete Tag Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
471 472 473 474 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 471 def delete_tag(id, opts = {}) delete_tag_with_http_info(id, opts) nil end |
#delete_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Delete Tag Group Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
536 537 538 539 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 536 def delete_tag_group(id, opts = {}) data, _status_code, _headers = delete_tag_group_with_http_info(id, opts) data end |
#delete_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Delete Tag Group Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags:write`
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 594 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 546 def delete_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_group ...' 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 TagsApi.delete_tag_group" end # resource path local_var_path = '/api/tag-groups/{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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.delete_tag_group", :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: TagsApi#delete_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) ⇒ nil
Delete Tag Relationships Campaigns Remove a tag’s association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:write` `tags:write`
602 603 604 605 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 602 def delete_tag_relationships_campaigns(id, tag_campaign_op, opts = {}) delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts) nil end |
#delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Campaigns Remove a tag's association with one or more campaigns. Use the request body to pass in the ID(s) of the campaign(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:write` `tags:write`
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 659 660 661 662 663 664 665 666 667 668 669 670 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 613 def delete_tag_relationships_campaigns_with_http_info(id, tag_campaign_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_campaigns ...' 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 TagsApi.delete_tag_relationships_campaigns" end # verify the required parameter 'tag_campaign_op' is set if @api_client.config.client_side_validation && tag_campaign_op.nil? fail ArgumentError, "Missing the required parameter 'tag_campaign_op' when calling TagsApi.delete_tag_relationships_campaigns" end # resource path local_var_path = '/api/tags/{id}/relationships/campaigns/'.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(tag_campaign_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.delete_tag_relationships_campaigns", :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: TagsApi#delete_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_relationships_flows(id, tag_flow_op, opts = {}) ⇒ nil
Delete Tag Relationships Flows Remove a tag’s association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:write` `tags:write`
678 679 680 681 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 678 def delete_tag_relationships_flows(id, tag_flow_op, opts = {}) delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts) nil end |
#delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Flows Remove a tag's association with one or more flows. Use the request body to pass in the ID(s) of the flows(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `flows:write` `tags:write`
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 735 736 737 738 739 740 741 742 743 744 745 746 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 689 def delete_tag_relationships_flows_with_http_info(id, tag_flow_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_flows ...' 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 TagsApi.delete_tag_relationships_flows" end # verify the required parameter 'tag_flow_op' is set if @api_client.config.client_side_validation && tag_flow_op.nil? fail ArgumentError, "Missing the required parameter 'tag_flow_op' when calling TagsApi.delete_tag_relationships_flows" end # resource path local_var_path = '/api/tags/{id}/relationships/flows/'.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(tag_flow_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.delete_tag_relationships_flows", :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: TagsApi#delete_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_relationships_lists(id, tag_list_op, opts = {}) ⇒ nil
Delete Tag Relationships Lists Remove a tag’s association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `list:write` `tags:write`
754 755 756 757 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 754 def delete_tag_relationships_lists(id, tag_list_op, opts = {}) delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts) nil end |
#delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Lists Remove a tag's association with one or more lists. Use the request body to pass in the ID(s) of the list(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `list:write` `tags:write`
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 765 def delete_tag_relationships_lists_with_http_info(id, tag_list_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_lists ...' 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 TagsApi.delete_tag_relationships_lists" end # verify the required parameter 'tag_list_op' is set if @api_client.config.client_side_validation && tag_list_op.nil? fail ArgumentError, "Missing the required parameter 'tag_list_op' when calling TagsApi.delete_tag_relationships_lists" end # resource path local_var_path = '/api/tags/{id}/relationships/lists/'.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(tag_list_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.delete_tag_relationships_lists", :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: TagsApi#delete_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_relationships_segments(id, tag_segment_op, opts = {}) ⇒ nil
Delete Tag Relationships Segments Remove a tag’s association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:write` `tags:write`
830 831 832 833 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 830 def delete_tag_relationships_segments(id, tag_segment_op, opts = {}) delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts) nil end |
#delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Relationships Segments Remove a tag's association with one or more segments. Use the request body to pass in the ID(s) of the segments(s) whose association with the tag will be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `segments:write` `tags:write`
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 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 841 def delete_tag_relationships_segments_with_http_info(id, tag_segment_op, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag_relationships_segments ...' 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 TagsApi.delete_tag_relationships_segments" end # verify the required parameter 'tag_segment_op' is set if @api_client.config.client_side_validation && tag_segment_op.nil? fail ArgumentError, "Missing the required parameter 'tag_segment_op' when calling TagsApi.delete_tag_relationships_segments" end # resource path local_var_path = '/api/tags/{id}/relationships/segments/'.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(tag_segment_op) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.delete_tag_relationships_segments", :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: TagsApi#delete_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_tag_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Tag Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags:write`
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 518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 481 def delete_tag_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...' 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 TagsApi.delete_tag" end # resource path local_var_path = '/api/tags/{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 => :"TagsApi.delete_tag", :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: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Retrieve the tag with the given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
908 909 910 911 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 908 def get_tag(id, opts = {}) data, _status_code, _headers = get_tag_with_http_info(id, opts) data end |
#get_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Retrieve the tag group with the given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
992 993 994 995 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 992 def get_tag_group(id, opts = {}) data, _status_code, _headers = get_tag_group_with_http_info(id, opts) data end |
#get_tag_group_relationships_tags(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Relationships Tags Returns the tag IDs of all tags inside the given tag group.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
1063 1064 1065 1066 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1063 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_tag_group_relationships_tags_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Relationships Tags Returns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
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 1118 1119 1120 1121 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1073 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_relationships_tags ...' 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 TagsApi.get_tag_group_relationships_tags" end # resource path local_var_path = '/api/tag-groups/{id}/relationships/tags/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_group_relationships_tags", :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: TagsApi#get_tag_group_relationships_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_group_tags(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Group Tags Return the tags for a given tag group ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
1129 1130 1131 1132 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1129 def (id, opts = {}) data, _status_code, _headers = (id, opts) data end |
#get_tag_group_tags_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Tags Return the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags: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 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1140 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group_tags ...' 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 TagsApi.get_tag_group_tags" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/tag-groups/{id}/tags/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].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 => :"TagsApi.get_tag_group_tags", :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: TagsApi#get_tag_group_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Group Retrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
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 1050 1051 1052 1053 1054 1055 1056 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1003 def get_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_group ...' 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 TagsApi.get_tag_group" end allowable_values = ["name", "exclusive", "default"] if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/tag-groups/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].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 => :"TagsApi.get_tag_group", :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: TagsApi#get_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_groups(opts = {}) ⇒ Hash<String, Object>
Get Tag Groups List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by ‘name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read`
1203 1204 1205 1206 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1203 def get_tag_groups(opts = {}) data, _status_code, _headers = get_tag_groups_with_http_info(opts) data end |
#get_tag_groups_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Groups List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 25 tag groups per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1216 def get_tag_groups_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_groups ...' end allowable_values = ["name", "exclusive", "default"] if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}" end allowable_values = ["id", "-id", "name", "-name"] 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/tag-groups/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].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 => :"TagsApi.get_tag_groups", :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: TagsApi#get_tag_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_relationships_campaigns(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Campaigns Returns the IDs of all campaigns associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1279 1280 1281 1282 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1279 def get_tag_relationships_campaigns(id, opts = {}) data, _status_code, _headers = get_tag_relationships_campaigns_with_http_info(id, opts) data end |
#get_tag_relationships_campaigns_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Campaigns Returns the IDs of all campaigns associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `campaigns:read` `tags:read`
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1289 def get_tag_relationships_campaigns_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_campaigns ...' 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 TagsApi.get_tag_relationships_campaigns" end # resource path local_var_path = '/api/tags/{id}/relationships/campaigns/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_relationships_campaigns", :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: TagsApi#get_tag_relationships_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_relationships_flows(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Flows Returns the IDs of all flows associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `flows:read` `tags:read`
1344 1345 1346 1347 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1344 def get_tag_relationships_flows(id, opts = {}) data, _status_code, _headers = get_tag_relationships_flows_with_http_info(id, opts) data end |
#get_tag_relationships_flows_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Flows Returns the IDs of all flows associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `flows:read` `tags:read`
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1354 def get_tag_relationships_flows_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_flows ...' 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 TagsApi.get_tag_relationships_flows" end # resource path local_var_path = '/api/tags/{id}/relationships/flows/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_relationships_flows", :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: TagsApi#get_tag_relationships_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_relationships_lists(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Lists Returns the IDs of all lists associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `list:read` `tags:read`
1409 1410 1411 1412 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1409 def get_tag_relationships_lists(id, opts = {}) data, _status_code, _headers = get_tag_relationships_lists_with_http_info(id, opts) data end |
#get_tag_relationships_lists_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Lists Returns the IDs of all lists associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `list:read` `tags:read`
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1419 def get_tag_relationships_lists_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_lists ...' 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 TagsApi.get_tag_relationships_lists" end # resource path local_var_path = '/api/tags/{id}/relationships/lists/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_relationships_lists", :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: TagsApi#get_tag_relationships_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_relationships_segments(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Segments Returns the IDs of all segments associated with the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `segments:read` `tags:read`
1474 1475 1476 1477 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1474 def get_tag_relationships_segments(id, opts = {}) data, _status_code, _headers = get_tag_relationships_segments_with_http_info(id, opts) data end |
#get_tag_relationships_segments_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Segments Returns the IDs of all segments associated with the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `segments:read` `tags:read`
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 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1484 def get_tag_relationships_segments_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_segments ...' 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 TagsApi.get_tag_relationships_segments" end # resource path local_var_path = '/api/tags/{id}/relationships/segments/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_relationships_segments", :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: TagsApi#get_tag_relationships_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_relationships_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Relationships Tag Group Returns the id of the tag group related to the given tag.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
1539 1540 1541 1542 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1539 def get_tag_relationships_tag_group(id, opts = {}) data, _status_code, _headers = get_tag_relationships_tag_group_with_http_info(id, opts) data end |
#get_tag_relationships_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Relationships Tag Group Returns the id of the tag group related to the given tag.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1549 def get_tag_relationships_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_relationships_tag_group ...' 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 TagsApi.get_tag_relationships_tag_group" end # resource path local_var_path = '/api/tags/{id}/relationships/tag-group/'.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] || 'Hash<String, Object>' # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.get_tag_relationships_tag_group", :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: TagsApi#get_tag_relationships_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_tag_group(id, opts = {}) ⇒ Hash<String, Object>
Get Tag Tag Group Returns the tag group resource for a given tag ID.
*Rate limits*:
Burst: ‘3/s`
Steady: `60/m` Scopes: `tags:read`
1605 1606 1607 1608 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1605 def get_tag_tag_group(id, opts = {}) data, _status_code, _headers = get_tag_tag_group_with_http_info(id, opts) data end |
#get_tag_tag_group_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Tag Group Returns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1616 def get_tag_tag_group_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_tag_group ...' 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 TagsApi.get_tag_tag_group" end allowable_values = ["name", "exclusive", "default"] if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}" end # resource path local_var_path = '/api/tags/{id}/tag-group/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].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 => :"TagsApi.get_tag_tag_group", :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: TagsApi#get_tag_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tag_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tag Retrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 921 def get_tag_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tag ...' 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 TagsApi.get_tag" end allowable_values = ["name", "exclusive", "default"] if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end allowable_values = ["tag-group"] 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/tags/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil? query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].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 => :"TagsApi.get_tag", :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: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_tags(opts = {}) ⇒ Hash<String, Object>
Get Tags List all tags in an account. Tags can be filtered by ‘name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read`
1681 1682 1683 1684 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1681 def (opts = {}) data, _status_code, _headers = (opts) data end |
#get_tags_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Get Tags List all tags in an account. Tags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order. Returns a maximum of 50 tags per request, which can be paginated with [cursor-based pagination](developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read`
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1696 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.get_tags ...' end allowable_values = ["name", "exclusive", "default"] if @api_client.config.client_side_validation && opts[:'fields_tag_group'] && !opts[:'fields_tag_group'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag_group\", must include one of #{allowable_values}" end allowable_values = ["name"] if @api_client.config.client_side_validation && opts[:'fields_tag'] && !opts[:'fields_tag'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"fields_tag\", must include one of #{allowable_values}" end allowable_values = ["tag-group"] 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 = ["id", "-id", "name", "-name"] 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/tags/' # query parameters query_params = opts[:query_params] || {} query_params[:'fields[tag-group]'] = @api_client.build_collection_param(opts[:'fields_tag_group'], :csv) if !opts[:'fields_tag_group'].nil? query_params[:'fields[tag]'] = @api_client.build_collection_param(opts[:'fields_tag'], :csv) if !opts[:'fields_tag'].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 => :"TagsApi.get_tags", :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: TagsApi#get_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tag(id, tag_update_query, opts = {}) ⇒ nil
Update Tag Update the tag with the given tag ID. Only a tag’s ‘name` can be changed. A tag cannot be moved from one tag group to another.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
1770 1771 1772 1773 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1770 def update_tag(id, tag_update_query, opts = {}) update_tag_with_http_info(id, tag_update_query, opts) nil end |
#update_tag_group(id, tag_group_update_query, opts = {}) ⇒ Hash<String, Object>
Update Tag Group Update the tag group with the given tag group ID. Only a tag group’s ‘name` can be changed. A tag group’s ‘exclusive` or `default` value cannot be changed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m` Scopes: `tags:read` `tags:write`
1846 1847 1848 1849 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1846 def update_tag_group(id, tag_group_update_query, opts = {}) data, _status_code, _headers = update_tag_group_with_http_info(id, tag_group_update_query, opts) data end |
#update_tag_group_with_http_info(id, tag_group_update_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>
Update Tag Group Update the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags:write`
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1857 def update_tag_group_with_http_info(id, tag_group_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.update_tag_group ...' 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 TagsApi.update_tag_group" end # verify the required parameter 'tag_group_update_query' is set if @api_client.config.client_side_validation && tag_group_update_query.nil? fail ArgumentError, "Missing the required parameter 'tag_group_update_query' when calling TagsApi.update_tag_group" end # resource path local_var_path = '/api/tag-groups/{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(tag_group_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 => :"TagsApi.update_tag_group", :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: TagsApi#update_tag_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_tag_with_http_info(id, tag_update_query, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Tag Update the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` Scopes: `tags:read` `tags:write`
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 |
# File 'lib/klaviyo-api-sdk/api/tags_api.rb', line 1781 def update_tag_with_http_info(id, tag_update_query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...' 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 TagsApi.update_tag" end # verify the required parameter 'tag_update_query' is set if @api_client.config.client_side_validation && tag_update_query.nil? fail ArgumentError, "Missing the required parameter 'tag_update_query' when calling TagsApi.update_tag" end # resource path local_var_path = '/api/tags/{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(tag_update_query) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key'] = opts.merge( :operation => :"TagsApi.update_tag", :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: TagsApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |