klaviyo-api-sdk 8.0.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -30,6 +30,9 @@ module KlaviyoAPI
30
30
  data
31
31
  end
32
32
 
33
+ # alias of `query_campaign_values`
34
+ alias create_campaign_value_report query_campaign_values
35
+
33
36
  # Query Campaign Values
34
37
  # Returns the requested campaign analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `campaigns:read`
35
38
  # @param campaign_values_request_dto [CampaignValuesRequestDTO]
@@ -92,6 +95,9 @@ module KlaviyoAPI
92
95
  return data, status_code, headers
93
96
  end
94
97
 
98
+ # alias of `query_campaign_values_with_http_info`
99
+ alias create_campaign_value_report_with_http_info query_campaign_values_with_http_info
100
+
95
101
  # Query Flow Series
96
102
  # Returns the requested flow analytics series data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read`
97
103
  # @param flow_series_request_dto [FlowSeriesRequestDTO]
@@ -103,6 +109,9 @@ module KlaviyoAPI
103
109
  data
104
110
  end
105
111
 
112
+ # alias of `query_flow_series`
113
+ alias create_flow_sery_report query_flow_series
114
+
106
115
  # Query Flow Series
107
116
  # Returns the requested flow analytics series data&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;2/m&#x60;&lt;br&gt;Daily: &#x60;225/d&#x60; **Scopes:** &#x60;flows:read&#x60;
108
117
  # @param flow_series_request_dto [FlowSeriesRequestDTO]
@@ -165,6 +174,9 @@ module KlaviyoAPI
165
174
  return data, status_code, headers
166
175
  end
167
176
 
177
+ # alias of `query_flow_series_with_http_info`
178
+ alias create_flow_sery_report_with_http_info query_flow_series_with_http_info
179
+
168
180
  # Query Flow Values
169
181
  # Returns the requested flow analytics values data<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `2/m`<br>Daily: `225/d` **Scopes:** `flows:read`
170
182
  # @param flow_values_request_dto [FlowValuesRequestDTO]
@@ -176,6 +188,9 @@ module KlaviyoAPI
176
188
  data
177
189
  end
178
190
 
191
+ # alias of `query_flow_values`
192
+ alias create_flow_value_report query_flow_values
193
+
179
194
  # Query Flow Values
180
195
  # Returns the requested flow analytics values data&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;1/s&#x60;&lt;br&gt;Steady: &#x60;2/m&#x60;&lt;br&gt;Daily: &#x60;225/d&#x60; **Scopes:** &#x60;flows:read&#x60;
181
196
  # @param flow_values_request_dto [FlowValuesRequestDTO]
@@ -237,5 +252,8 @@ module KlaviyoAPI
237
252
  end
238
253
  return data, status_code, headers
239
254
  end
255
+
256
+ # alias of `query_flow_values_with_http_info`
257
+ alias create_flow_value_report_with_http_info query_flow_values_with_http_info
240
258
  end
241
259
  end
@@ -286,7 +286,7 @@ module KlaviyoAPI
286
286
  if @api_client.config.client_side_validation && opts[:'additional_fields_profile'] && !opts[:'additional_fields_profile'].all? { |item| allowable_values.include?(item) }
287
287
  fail ArgumentError, "invalid value for \"additional_fields_profile\", must include one of #{allowable_values}"
288
288
  end
289
- allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
289
+ allowable_values = ["email", "phone_number", "external_id", "first_name", "last_name", "organization", "locale", "title", "image", "created", "updated", "last_event_date", "location", "location.address1", "location.address2", "location.city", "location.country", "location.latitude", "location.longitude", "location.region", "location.zip", "location.timezone", "location.ip", "properties", "joined_group_at", "subscriptions", "subscriptions.email", "subscriptions.email.marketing", "subscriptions.email.marketing.can_receive_email_marketing", "subscriptions.email.marketing.consent", "subscriptions.email.marketing.consent_timestamp", "subscriptions.email.marketing.last_updated", "subscriptions.email.marketing.method", "subscriptions.email.marketing.method_detail", "subscriptions.email.marketing.custom_method_detail", "subscriptions.email.marketing.double_optin", "subscriptions.email.marketing.suppression", "subscriptions.email.marketing.list_suppressions", "subscriptions.sms", "subscriptions.sms.marketing", "subscriptions.sms.marketing.can_receive_sms_marketing", "subscriptions.sms.marketing.consent", "subscriptions.sms.marketing.consent_timestamp", "subscriptions.sms.marketing.method", "subscriptions.sms.marketing.method_detail", "subscriptions.sms.marketing.last_updated", "subscriptions.mobile_push", "subscriptions.mobile_push.marketing", "subscriptions.mobile_push.marketing.can_receive_push_marketing", "subscriptions.mobile_push.marketing.consent", "subscriptions.mobile_push.marketing.consent_timestamp", "predictive_analytics", "predictive_analytics.historic_clv", "predictive_analytics.predicted_clv", "predictive_analytics.total_clv", "predictive_analytics.historic_number_of_orders", "predictive_analytics.predicted_number_of_orders", "predictive_analytics.average_days_between_orders", "predictive_analytics.average_order_value", "predictive_analytics.churn_probability", "predictive_analytics.expected_date_of_next_order"]
290
290
  if @api_client.config.client_side_validation && opts[:'fields_profile'] && !opts[:'fields_profile'].all? { |item| allowable_values.include?(item) }
291
291
  fail ArgumentError, "invalid value for \"fields_profile\", must include one of #{allowable_values}"
292
292
  end
@@ -170,6 +170,9 @@ module KlaviyoAPI
170
170
  nil
171
171
  end
172
172
 
173
+ # alias of `create_tag_relationships_campaigns`
174
+ alias create_tag_relationships_campaign create_tag_relationships_campaigns
175
+
173
176
  # Create Tag Relationships Campaigns
174
177
  # 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.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;campaigns:write&#x60; &#x60;tags:write&#x60;
175
178
  # @param id [String]
@@ -235,6 +238,9 @@ module KlaviyoAPI
235
238
  return data, status_code, headers
236
239
  end
237
240
 
241
+ # alias of `create_tag_relationships_campaigns_with_http_info`
242
+ alias create_tag_relationships_campaign_with_http_info create_tag_relationships_campaigns_with_http_info
243
+
238
244
  # Create Tag Relationships Flows
239
245
  # 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`
240
246
  # @param id [String]
@@ -246,6 +252,9 @@ module KlaviyoAPI
246
252
  nil
247
253
  end
248
254
 
255
+ # alias of `create_tag_relationships_flows`
256
+ alias create_tag_relationships_flow create_tag_relationships_flows
257
+
249
258
  # Create Tag Relationships Flows
250
259
  # 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.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;flows:write&#x60; &#x60;tags:write&#x60;
251
260
  # @param id [String]
@@ -311,6 +320,9 @@ module KlaviyoAPI
311
320
  return data, status_code, headers
312
321
  end
313
322
 
323
+ # alias of `create_tag_relationships_flows_with_http_info`
324
+ alias create_tag_relationships_flow_with_http_info create_tag_relationships_flows_with_http_info
325
+
314
326
  # Create Tag Relationships Lists
315
327
  # 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:** `lists:write` `tags:write`
316
328
  # @param id [String]
@@ -322,6 +334,9 @@ module KlaviyoAPI
322
334
  nil
323
335
  end
324
336
 
337
+ # alias of `create_tag_relationships_lists`
338
+ alias create_tag_relationships_list create_tag_relationships_lists
339
+
325
340
  # Create Tag Relationships Lists
326
341
  # 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.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;lists:write&#x60; &#x60;tags:write&#x60;
327
342
  # @param id [String]
@@ -387,6 +402,9 @@ module KlaviyoAPI
387
402
  return data, status_code, headers
388
403
  end
389
404
 
405
+ # alias of `create_tag_relationships_lists_with_http_info`
406
+ alias create_tag_relationships_list_with_http_info create_tag_relationships_lists_with_http_info
407
+
390
408
  # Create Tag Relationships Segments
391
409
  # 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`
392
410
  # @param id [String]
@@ -398,6 +416,9 @@ module KlaviyoAPI
398
416
  nil
399
417
  end
400
418
 
419
+ # alias of `create_tag_relationships_segments`
420
+ alias create_tag_relationships_segment create_tag_relationships_segments
421
+
401
422
  # Create Tag Relationships Segments
402
423
  # 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.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; **Scopes:** &#x60;segments:write&#x60; &#x60;tags:write&#x60;
403
424
  # @param id [String]
@@ -463,6 +484,9 @@ module KlaviyoAPI
463
484
  return data, status_code, headers
464
485
  end
465
486
 
487
+ # alias of `create_tag_relationships_segments_with_http_info`
488
+ alias create_tag_relationships_segment_with_http_info create_tag_relationships_segments_with_http_info
489
+
466
490
  # Delete Tag
467
491
  # 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`
468
492
  # @param id [String] The Tag ID
@@ -32,7 +32,7 @@ module KlaviyoAPI
32
32
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
33
33
  def initialize(config = Configuration.default)
34
34
  @config = config
35
- @user_agent = "klaviyo-api-ruby/8.0.0"
35
+ @user_agent = "klaviyo-api-ruby/9.0.0"
36
36
  @default_headers = {
37
37
  'Content-Type' => 'application/json',
38
38
  'User-Agent' => @user_agent
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: klaviyo-api-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 8.0.0
4
+ version: 9.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Klaviyo Team
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-07-15 00:00:00.000000000 Z
11
+ date: 2024-08-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: retriable
@@ -51,6 +51,7 @@ executables: []
51
51
  extensions: []
52
52
  extra_rdoc_files: []
53
53
  files:
54
+ - CHANGELOG.md
54
55
  - Gemfile
55
56
  - LICENSE.md
56
57
  - README.md
@@ -1715,7 +1716,7 @@ licenses:
1715
1716
  metadata:
1716
1717
  changelog_uri: https://github.com/klaviyo/klaviyo-api-ruby/blob/main/CHANGELOG.md
1717
1718
  documentation_uri: https://github.com/klaviyo/klaviyo-api-ruby/blob/main/README.md
1718
- post_install_message:
1719
+ post_install_message:
1719
1720
  rdoc_options: []
1720
1721
  require_paths:
1721
1722
  - lib
@@ -1730,9 +1731,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
1730
1731
  - !ruby/object:Gem::Version
1731
1732
  version: '0'
1732
1733
  requirements: []
1733
- rubyforge_project:
1734
- rubygems_version: 2.7.6
1735
- signing_key:
1734
+ rubygems_version: 3.5.11
1735
+ signing_key:
1736
1736
  specification_version: 4
1737
1737
  summary: You heard us, a Ruby wrapper for the Klaviyo API
1738
1738
  test_files: []