klaviyo-api-sdk 10.0.0 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -0
- data/README.md +382 -136
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +41 -23
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +82 -76
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +111 -93
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +128 -116
- data/lib/klaviyo-api-sdk/api/flows_api.rb +199 -169
- data/lib/klaviyo-api-sdk/api/forms_api.rb +19 -7
- data/lib/klaviyo-api-sdk/api/images_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/lists_api.rb +391 -337
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +151 -115
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +170 -119
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +49 -7
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/segments_api.rb +170 -146
- data/lib/klaviyo-api-sdk/api/tags_api.rb +108 -42
- data/lib/klaviyo-api-sdk/api/templates_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +18 -9
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +34 -0
- data/lib/klaviyo-api-sdk/models/device_metadata.rb +2 -2
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/html_block_data.rb +4 -14
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/sms_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk.rb +36 -19
- metadata +6 -2
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version:
|
3
|
+
- SDK version: 11.1.0
|
4
4
|
- API revision: 2024-10-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
@@ -110,13 +110,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
110
110
|
Then install the gem locally:
|
111
111
|
|
112
112
|
```shell
|
113
|
-
gem install ./klaviyo-api-sdk-
|
113
|
+
gem install ./klaviyo-api-sdk-11.1.0.gem
|
114
114
|
```
|
115
115
|
|
116
116
|
|
117
117
|
Finally add this to the Gemfile:
|
118
118
|
|
119
|
-
gem 'klaviyo-api-sdk', '~>
|
119
|
+
gem 'klaviyo-api-sdk', '~> 11.1.0'
|
120
120
|
|
121
121
|
To install directly from rubygems:
|
122
122
|
|
@@ -152,8 +152,10 @@ end
|
|
152
152
|
|
153
153
|
NOTE:
|
154
154
|
* The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
|
155
|
-
* `
|
156
|
-
*
|
155
|
+
* `max_retries` denotes the number of attempts the client will make in order to execute the request successfully.
|
156
|
+
* Set to 0 to disable automatic retries
|
157
|
+
* `max_delay` denotes the maximum amount of time (in seconds) that will be spent retrying a request across all attempts.
|
158
|
+
* The time interval between retries is calculated using exponential backoff and the `Retry-After` header.
|
157
159
|
|
158
160
|
### To call the `get_catalog_items` operation:
|
159
161
|
|
@@ -170,6 +172,18 @@ begin
|
|
170
172
|
end
|
171
173
|
```
|
172
174
|
|
175
|
+
## OAuth Authentication
|
176
|
+
|
177
|
+
To use OAuth Authentication, pass an access token instead of an API key:
|
178
|
+
|
179
|
+
```ruby
|
180
|
+
KlaviyoAPI.configure do |config|
|
181
|
+
config.access_token = 'your-oauth-access-token'
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
See our [guide](https://developers.klaviyo.com/en/docs/set_up_oauth) for an overview on setting up an OAuth integration.
|
186
|
+
|
173
187
|
## Error Handling
|
174
188
|
|
175
189
|
This SDK throws an `ApiException` error when the server returns a non-`2XX` response.
|
@@ -677,6 +691,10 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
677
691
|
```ruby
|
678
692
|
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
679
693
|
```
|
694
|
+
##### Method alias:
|
695
|
+
```ruby
|
696
|
+
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
|
697
|
+
```
|
680
698
|
|
681
699
|
|
682
700
|
|
@@ -701,6 +719,10 @@ KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
|
|
701
719
|
```ruby
|
702
720
|
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
|
703
721
|
```
|
722
|
+
##### Method alias:
|
723
|
+
```ruby
|
724
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id)
|
725
|
+
```
|
704
726
|
|
705
727
|
|
706
728
|
|
@@ -715,6 +737,10 @@ KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
|
715
737
|
```ruby
|
716
738
|
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
|
717
739
|
```
|
740
|
+
##### Method alias:
|
741
|
+
```ruby
|
742
|
+
KlaviyoAPI::Campaigns.get_campaign_messages(id, opts)
|
743
|
+
```
|
718
744
|
|
719
745
|
|
720
746
|
|
@@ -814,19 +840,23 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
814
840
|
## Catalogs
|
815
841
|
|
816
842
|
|
817
|
-
#### [Add
|
843
|
+
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/add_categories_to_catalog_item)
|
818
844
|
|
819
845
|
```ruby
|
820
|
-
KlaviyoAPI::Catalogs.
|
846
|
+
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
|
821
847
|
```
|
822
848
|
##### Method alias:
|
823
849
|
```ruby
|
824
|
-
KlaviyoAPI::Catalogs.
|
850
|
+
KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body)
|
825
851
|
```
|
826
852
|
##### Method alias:
|
827
853
|
```ruby
|
828
854
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body)
|
829
855
|
```
|
856
|
+
##### Method alias:
|
857
|
+
```ruby
|
858
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
859
|
+
```
|
830
860
|
|
831
861
|
|
832
862
|
|
@@ -839,11 +869,11 @@ KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
|
839
869
|
```
|
840
870
|
##### Method alias:
|
841
871
|
```ruby
|
842
|
-
KlaviyoAPI::Catalogs.
|
872
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body)
|
843
873
|
```
|
844
874
|
##### Method alias:
|
845
875
|
```ruby
|
846
|
-
KlaviyoAPI::Catalogs.
|
876
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
847
877
|
```
|
848
878
|
|
849
879
|
|
@@ -1664,34 +1694,42 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
|
1664
1694
|
|
1665
1695
|
|
1666
1696
|
|
1667
|
-
#### [Get
|
1697
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon)
|
1668
1698
|
|
1669
1699
|
```ruby
|
1670
|
-
KlaviyoAPI::Coupons.
|
1671
|
-
```
|
1672
|
-
##### Method alias:
|
1673
|
-
```ruby
|
1674
|
-
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
|
1700
|
+
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
1675
1701
|
```
|
1676
1702
|
|
1677
1703
|
|
1678
1704
|
|
1679
1705
|
|
1680
1706
|
|
1681
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
1707
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code)
|
1682
1708
|
|
1683
1709
|
```ruby
|
1684
|
-
KlaviyoAPI::Coupons.
|
1710
|
+
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
1685
1711
|
```
|
1686
1712
|
|
1687
1713
|
|
1688
1714
|
|
1689
1715
|
|
1690
1716
|
|
1691
|
-
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
1717
|
+
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code_ids_for_coupon)
|
1692
1718
|
|
1693
1719
|
```ruby
|
1694
|
-
KlaviyoAPI::Coupons.
|
1720
|
+
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
|
1721
|
+
```
|
1722
|
+
##### Method alias:
|
1723
|
+
```ruby
|
1724
|
+
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
|
1725
|
+
```
|
1726
|
+
##### Method alias:
|
1727
|
+
```ruby
|
1728
|
+
KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts)
|
1729
|
+
```
|
1730
|
+
##### Method alias:
|
1731
|
+
```ruby
|
1732
|
+
KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
|
1695
1733
|
```
|
1696
1734
|
|
1697
1735
|
|
@@ -1708,7 +1746,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
|
|
1708
1746
|
|
1709
1747
|
|
1710
1748
|
|
1711
|
-
#### [Get Coupon Codes
|
1749
|
+
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes_for_coupon)
|
1712
1750
|
|
1713
1751
|
```ruby
|
1714
1752
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
@@ -1717,6 +1755,10 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
1717
1755
|
```ruby
|
1718
1756
|
KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts)
|
1719
1757
|
```
|
1758
|
+
##### Method alias:
|
1759
|
+
```ruby
|
1760
|
+
KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
|
1761
|
+
```
|
1720
1762
|
|
1721
1763
|
|
1722
1764
|
|
@@ -1836,44 +1878,52 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
1836
1878
|
|
1837
1879
|
|
1838
1880
|
|
1839
|
-
#### [Get
|
1881
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events)
|
1840
1882
|
|
1841
1883
|
```ruby
|
1842
|
-
KlaviyoAPI::Events.
|
1884
|
+
KlaviyoAPI::Events.get_events(opts)
|
1843
1885
|
```
|
1844
1886
|
|
1845
1887
|
|
1846
1888
|
|
1847
1889
|
|
1848
1890
|
|
1849
|
-
#### [Get Event
|
1891
|
+
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_for_event)
|
1850
1892
|
|
1851
1893
|
```ruby
|
1852
|
-
KlaviyoAPI::Events.
|
1894
|
+
KlaviyoAPI::Events.get_metric_for_event(id, opts)
|
1895
|
+
```
|
1896
|
+
##### Method alias:
|
1897
|
+
```ruby
|
1898
|
+
KlaviyoAPI::Events.get_event_metric(id, opts)
|
1853
1899
|
```
|
1854
1900
|
|
1855
1901
|
|
1856
1902
|
|
1857
1903
|
|
1858
1904
|
|
1859
|
-
#### [Get
|
1905
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_event)
|
1860
1906
|
|
1861
1907
|
```ruby
|
1862
|
-
KlaviyoAPI::Events.
|
1908
|
+
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
1909
|
+
```
|
1910
|
+
##### Method alias:
|
1911
|
+
```ruby
|
1912
|
+
KlaviyoAPI::Events.get_event_relationships_metric(id)
|
1863
1913
|
```
|
1864
1914
|
|
1865
1915
|
|
1866
1916
|
|
1867
1917
|
|
1868
1918
|
|
1869
|
-
#### [Get
|
1919
|
+
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_for_event)
|
1870
1920
|
|
1871
1921
|
```ruby
|
1872
|
-
KlaviyoAPI::Events.
|
1922
|
+
KlaviyoAPI::Events.get_profile_for_event(id, opts)
|
1873
1923
|
```
|
1874
1924
|
##### Method alias:
|
1875
1925
|
```ruby
|
1876
|
-
KlaviyoAPI::Events.
|
1926
|
+
KlaviyoAPI::Events.get_event_profile(id, opts)
|
1877
1927
|
```
|
1878
1928
|
|
1879
1929
|
|
@@ -1908,6 +1958,20 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
1908
1958
|
|
1909
1959
|
|
1910
1960
|
|
1961
|
+
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_for_flow_message)
|
1962
|
+
|
1963
|
+
```ruby
|
1964
|
+
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
|
1965
|
+
```
|
1966
|
+
##### Method alias:
|
1967
|
+
```ruby
|
1968
|
+
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
1969
|
+
```
|
1970
|
+
|
1971
|
+
|
1972
|
+
|
1973
|
+
|
1974
|
+
|
1911
1975
|
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_id_for_flow_message)
|
1912
1976
|
|
1913
1977
|
```ruby
|
@@ -1931,6 +1995,10 @@ KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
|
1931
1995
|
```ruby
|
1932
1996
|
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
1933
1997
|
```
|
1998
|
+
##### Method alias:
|
1999
|
+
```ruby
|
2000
|
+
KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
|
2001
|
+
```
|
1934
2002
|
|
1935
2003
|
|
1936
2004
|
|
@@ -1945,6 +2013,10 @@ KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
|
1945
2013
|
```ruby
|
1946
2014
|
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
|
1947
2015
|
```
|
2016
|
+
##### Method alias:
|
2017
|
+
```ruby
|
2018
|
+
KlaviyoAPI::Flows.get_flow_actions(id, opts)
|
2019
|
+
```
|
1948
2020
|
|
1949
2021
|
|
1950
2022
|
|
@@ -1970,8 +2042,12 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
1970
2042
|
|
1971
2043
|
|
1972
2044
|
|
1973
|
-
#### [Get Flow
|
2045
|
+
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_for_flow_action)
|
1974
2046
|
|
2047
|
+
```ruby
|
2048
|
+
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
|
2049
|
+
```
|
2050
|
+
##### Method alias:
|
1975
2051
|
```ruby
|
1976
2052
|
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
1977
2053
|
```
|
@@ -2004,26 +2080,6 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
2004
2080
|
|
2005
2081
|
|
2006
2082
|
|
2007
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_message_action)
|
2008
|
-
|
2009
|
-
```ruby
|
2010
|
-
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
2011
|
-
```
|
2012
|
-
|
2013
|
-
|
2014
|
-
|
2015
|
-
|
2016
|
-
|
2017
|
-
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_tags)
|
2018
|
-
|
2019
|
-
```ruby
|
2020
|
-
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
2021
|
-
```
|
2022
|
-
|
2023
|
-
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
2083
|
#### [Get Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows)
|
2028
2084
|
|
2029
2085
|
```ruby
|
@@ -2076,6 +2132,20 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
2076
2132
|
|
2077
2133
|
|
2078
2134
|
|
2135
|
+
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_flow)
|
2136
|
+
|
2137
|
+
```ruby
|
2138
|
+
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
|
2139
|
+
```
|
2140
|
+
##### Method alias:
|
2141
|
+
```ruby
|
2142
|
+
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
2143
|
+
```
|
2144
|
+
|
2145
|
+
|
2146
|
+
|
2147
|
+
|
2148
|
+
|
2079
2149
|
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_for_flow_message)
|
2080
2150
|
|
2081
2151
|
```ruby
|
@@ -2185,6 +2255,10 @@ KlaviyoAPI::Forms.get_version_ids_for_form(id)
|
|
2185
2255
|
```ruby
|
2186
2256
|
KlaviyoAPI::Forms.get_form_relationships_form_versions(id)
|
2187
2257
|
```
|
2258
|
+
##### Method alias:
|
2259
|
+
```ruby
|
2260
|
+
KlaviyoAPI::Forms.get_form_relationships_versions(id)
|
2261
|
+
```
|
2188
2262
|
|
2189
2263
|
|
2190
2264
|
|
@@ -2199,6 +2273,10 @@ KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
|
2199
2273
|
```ruby
|
2200
2274
|
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
2201
2275
|
```
|
2276
|
+
##### Method alias:
|
2277
|
+
```ruby
|
2278
|
+
KlaviyoAPI::Forms.get_form_versions(id, opts)
|
2279
|
+
```
|
2202
2280
|
|
2203
2281
|
|
2204
2282
|
|
@@ -2270,24 +2348,32 @@ KlaviyoAPI::Images.create_image(body)
|
|
2270
2348
|
## Lists
|
2271
2349
|
|
2272
2350
|
|
2273
|
-
#### [
|
2351
|
+
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2024-10-15/reference/add_profiles_to_list)
|
2274
2352
|
|
2275
2353
|
```ruby
|
2276
|
-
KlaviyoAPI::Lists.
|
2354
|
+
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
|
2355
|
+
```
|
2356
|
+
##### Method alias:
|
2357
|
+
```ruby
|
2358
|
+
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
2359
|
+
```
|
2360
|
+
##### Method alias:
|
2361
|
+
```ruby
|
2362
|
+
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
2363
|
+
```
|
2364
|
+
##### Method alias:
|
2365
|
+
```ruby
|
2366
|
+
KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
|
2277
2367
|
```
|
2278
2368
|
|
2279
2369
|
|
2280
2370
|
|
2281
2371
|
|
2282
2372
|
|
2283
|
-
#### [
|
2373
|
+
#### [Create List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list)
|
2284
2374
|
|
2285
2375
|
```ruby
|
2286
|
-
KlaviyoAPI::Lists.
|
2287
|
-
```
|
2288
|
-
##### Method alias:
|
2289
|
-
```ruby
|
2290
|
-
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
2376
|
+
KlaviyoAPI::Lists.create_list(body)
|
2291
2377
|
```
|
2292
2378
|
|
2293
2379
|
|
@@ -2304,102 +2390,130 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
2304
2390
|
|
2305
2391
|
|
2306
2392
|
|
2307
|
-
#### [
|
2393
|
+
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_list)
|
2308
2394
|
|
2309
2395
|
```ruby
|
2310
|
-
KlaviyoAPI::Lists.
|
2396
|
+
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
|
2311
2397
|
```
|
2312
2398
|
##### Method alias:
|
2313
2399
|
```ruby
|
2314
|
-
KlaviyoAPI::Lists.
|
2400
|
+
KlaviyoAPI::Lists.get_flow_triggers_for_list(id, opts)
|
2401
|
+
```
|
2402
|
+
##### Method alias:
|
2403
|
+
```ruby
|
2404
|
+
KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
2315
2405
|
```
|
2316
2406
|
|
2317
2407
|
|
2318
2408
|
|
2319
2409
|
|
2320
2410
|
|
2321
|
-
#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
2411
|
+
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_list)
|
2322
2412
|
|
2323
2413
|
```ruby
|
2324
|
-
KlaviyoAPI::Lists.
|
2414
|
+
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
|
2415
|
+
```
|
2416
|
+
##### Method alias:
|
2417
|
+
```ruby
|
2418
|
+
KlaviyoAPI::Lists.get_flow_trigger_ids_for_list(id)
|
2419
|
+
```
|
2420
|
+
##### Method alias:
|
2421
|
+
```ruby
|
2422
|
+
KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
2325
2423
|
```
|
2326
2424
|
|
2327
2425
|
|
2328
2426
|
|
2329
2427
|
|
2330
2428
|
|
2331
|
-
#### [Get List
|
2429
|
+
#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list)
|
2332
2430
|
|
2333
2431
|
```ruby
|
2334
|
-
KlaviyoAPI::Lists.
|
2432
|
+
KlaviyoAPI::Lists.get_list(id, opts)
|
2335
2433
|
```
|
2336
2434
|
|
2337
2435
|
|
2338
2436
|
|
2339
2437
|
|
2340
2438
|
|
2341
|
-
#### [Get
|
2439
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists)
|
2342
2440
|
|
2343
2441
|
```ruby
|
2344
|
-
KlaviyoAPI::Lists.
|
2442
|
+
KlaviyoAPI::Lists.get_lists(opts)
|
2345
2443
|
```
|
2346
2444
|
|
2347
2445
|
|
2348
2446
|
|
2349
2447
|
|
2350
2448
|
|
2351
|
-
#### [Get
|
2449
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_list)
|
2352
2450
|
|
2353
2451
|
```ruby
|
2354
|
-
KlaviyoAPI::Lists.
|
2452
|
+
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
2453
|
+
```
|
2454
|
+
##### Method alias:
|
2455
|
+
```ruby
|
2456
|
+
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
2355
2457
|
```
|
2356
2458
|
|
2357
2459
|
|
2358
2460
|
|
2359
2461
|
|
2360
2462
|
|
2361
|
-
#### [Get List
|
2463
|
+
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_list)
|
2362
2464
|
|
2363
2465
|
```ruby
|
2364
|
-
KlaviyoAPI::Lists.
|
2466
|
+
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
|
2467
|
+
```
|
2468
|
+
##### Method alias:
|
2469
|
+
```ruby
|
2470
|
+
KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
2365
2471
|
```
|
2366
2472
|
|
2367
2473
|
|
2368
2474
|
|
2369
2475
|
|
2370
2476
|
|
2371
|
-
#### [Get
|
2477
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_list)
|
2372
2478
|
|
2373
2479
|
```ruby
|
2374
|
-
KlaviyoAPI::Lists.
|
2480
|
+
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
2481
|
+
```
|
2482
|
+
##### Method alias:
|
2483
|
+
```ruby
|
2484
|
+
KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
2375
2485
|
```
|
2376
2486
|
|
2377
2487
|
|
2378
2488
|
|
2379
2489
|
|
2380
2490
|
|
2381
|
-
#### [Get
|
2491
|
+
#### [Get Tags for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_list)
|
2382
2492
|
|
2383
2493
|
```ruby
|
2384
|
-
KlaviyoAPI::Lists.
|
2494
|
+
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
|
2385
2495
|
```
|
2386
2496
|
##### Method alias:
|
2387
2497
|
```ruby
|
2388
|
-
KlaviyoAPI::Lists.
|
2498
|
+
KlaviyoAPI::Lists.get_list_tags(id, opts)
|
2389
2499
|
```
|
2390
2500
|
|
2391
2501
|
|
2392
2502
|
|
2393
2503
|
|
2394
2504
|
|
2395
|
-
#### [
|
2505
|
+
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_profiles_from_list)
|
2396
2506
|
|
2397
2507
|
```ruby
|
2398
|
-
KlaviyoAPI::Lists.
|
2508
|
+
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
|
2399
2509
|
```
|
2400
2510
|
##### Method alias:
|
2401
2511
|
```ruby
|
2402
|
-
KlaviyoAPI::Lists.
|
2512
|
+
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
2513
|
+
```
|
2514
|
+
##### Method alias:
|
2515
|
+
```ruby
|
2516
|
+
KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
2403
2517
|
```
|
2404
2518
|
|
2405
2519
|
|
@@ -2420,20 +2534,46 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
2420
2534
|
## Metrics
|
2421
2535
|
|
2422
2536
|
|
2423
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
2537
|
+
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_metric)
|
2424
2538
|
|
2425
2539
|
```ruby
|
2426
|
-
KlaviyoAPI::Metrics.
|
2540
|
+
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
|
2541
|
+
```
|
2542
|
+
##### Method alias:
|
2543
|
+
```ruby
|
2544
|
+
KlaviyoAPI::Metrics.get_flow_triggers_for_metric(id, opts)
|
2545
|
+
```
|
2546
|
+
##### Method alias:
|
2547
|
+
```ruby
|
2548
|
+
KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
2427
2549
|
```
|
2428
2550
|
|
2429
2551
|
|
2430
2552
|
|
2431
2553
|
|
2432
2554
|
|
2433
|
-
#### [Get
|
2555
|
+
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_metric)
|
2434
2556
|
|
2435
2557
|
```ruby
|
2436
|
-
KlaviyoAPI::Metrics.
|
2558
|
+
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
|
2559
|
+
```
|
2560
|
+
##### Method alias:
|
2561
|
+
```ruby
|
2562
|
+
KlaviyoAPI::Metrics.get_flow_trigger_ids_for_metric(id)
|
2563
|
+
```
|
2564
|
+
##### Method alias:
|
2565
|
+
```ruby
|
2566
|
+
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
2567
|
+
```
|
2568
|
+
|
2569
|
+
|
2570
|
+
|
2571
|
+
|
2572
|
+
|
2573
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric)
|
2574
|
+
|
2575
|
+
```ruby
|
2576
|
+
KlaviyoAPI::Metrics.get_metric(id, opts)
|
2437
2577
|
```
|
2438
2578
|
|
2439
2579
|
|
@@ -2478,16 +2618,6 @@ KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
2478
2618
|
|
2479
2619
|
|
2480
2620
|
|
2481
|
-
#### [Get Metric Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_relationships_flow_triggers)
|
2482
|
-
|
2483
|
-
```ruby
|
2484
|
-
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
2485
|
-
```
|
2486
|
-
|
2487
|
-
|
2488
|
-
|
2489
|
-
|
2490
|
-
|
2491
2621
|
#### [Get Metrics](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metrics)
|
2492
2622
|
|
2493
2623
|
```ruby
|
@@ -2507,6 +2637,10 @@ KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
|
2507
2637
|
```ruby
|
2508
2638
|
KlaviyoAPI::Metrics.get_metric_metric_properties(id, opts)
|
2509
2639
|
```
|
2640
|
+
##### Method alias:
|
2641
|
+
```ruby
|
2642
|
+
KlaviyoAPI::Metrics.get_metric_properties(id, opts)
|
2643
|
+
```
|
2510
2644
|
|
2511
2645
|
|
2512
2646
|
|
@@ -2521,6 +2655,10 @@ KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
|
2521
2655
|
```ruby
|
2522
2656
|
KlaviyoAPI::Metrics.get_metric_relationships_metric_properties(id)
|
2523
2657
|
```
|
2658
|
+
##### Method alias:
|
2659
|
+
```ruby
|
2660
|
+
KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
|
2661
|
+
```
|
2524
2662
|
|
2525
2663
|
|
2526
2664
|
|
@@ -2544,6 +2682,24 @@ KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
|
2544
2682
|
## Profiles
|
2545
2683
|
|
2546
2684
|
|
2685
|
+
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_import_profiles)
|
2686
|
+
|
2687
|
+
```ruby
|
2688
|
+
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
2689
|
+
```
|
2690
|
+
##### Method alias:
|
2691
|
+
```ruby
|
2692
|
+
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2693
|
+
```
|
2694
|
+
##### Method alias:
|
2695
|
+
```ruby
|
2696
|
+
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2697
|
+
```
|
2698
|
+
|
2699
|
+
|
2700
|
+
|
2701
|
+
|
2702
|
+
|
2547
2703
|
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_subscribe_profiles)
|
2548
2704
|
|
2549
2705
|
```ruby
|
@@ -2619,11 +2775,11 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
|
2619
2775
|
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_or_update_profile)
|
2620
2776
|
|
2621
2777
|
```ruby
|
2622
|
-
KlaviyoAPI::Profiles.create_or_update_profile(body)
|
2778
|
+
KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
|
2623
2779
|
```
|
2624
2780
|
##### Method alias:
|
2625
2781
|
```ruby
|
2626
|
-
KlaviyoAPI::Profiles.create_profile_import(body)
|
2782
|
+
KlaviyoAPI::Profiles.create_profile_import(body, opts)
|
2627
2783
|
```
|
2628
2784
|
|
2629
2785
|
|
@@ -2633,7 +2789,7 @@ KlaviyoAPI::Profiles.create_profile_import(body)
|
|
2633
2789
|
#### [Create Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_profile)
|
2634
2790
|
|
2635
2791
|
```ruby
|
2636
|
-
KlaviyoAPI::Profiles.create_profile(body)
|
2792
|
+
KlaviyoAPI::Profiles.create_profile(body, opts)
|
2637
2793
|
```
|
2638
2794
|
|
2639
2795
|
|
@@ -2753,6 +2909,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
|
|
2753
2909
|
```
|
2754
2910
|
##### Method alias:
|
2755
2911
|
```ruby
|
2912
|
+
KlaviyoAPI::Profiles.get_import_errors_for_profile_bulk_import_job(id, opts)
|
2913
|
+
```
|
2914
|
+
##### Method alias:
|
2915
|
+
```ruby
|
2756
2916
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
2757
2917
|
```
|
2758
2918
|
|
@@ -2771,6 +2931,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
|
|
2771
2931
|
```
|
2772
2932
|
##### Method alias:
|
2773
2933
|
```ruby
|
2934
|
+
KlaviyoAPI::Profiles.get_lists_for_profile_bulk_import_job(id, opts)
|
2935
|
+
```
|
2936
|
+
##### Method alias:
|
2937
|
+
```ruby
|
2774
2938
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
2775
2939
|
```
|
2776
2940
|
|
@@ -2789,6 +2953,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
|
|
2789
2953
|
```
|
2790
2954
|
##### Method alias:
|
2791
2955
|
```ruby
|
2956
|
+
KlaviyoAPI::Profiles.get_list_ids_for_profile_bulk_import_job(id)
|
2957
|
+
```
|
2958
|
+
##### Method alias:
|
2959
|
+
```ruby
|
2792
2960
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
2793
2961
|
```
|
2794
2962
|
|
@@ -2847,6 +3015,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts
|
|
2847
3015
|
```ruby
|
2848
3016
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts)
|
2849
3017
|
```
|
3018
|
+
##### Method alias:
|
3019
|
+
```ruby
|
3020
|
+
KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
|
3021
|
+
```
|
2850
3022
|
|
2851
3023
|
|
2852
3024
|
|
@@ -2875,6 +3047,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
|
|
2875
3047
|
```ruby
|
2876
3048
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts)
|
2877
3049
|
```
|
3050
|
+
##### Method alias:
|
3051
|
+
```ruby
|
3052
|
+
KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
|
3053
|
+
```
|
2878
3054
|
|
2879
3055
|
|
2880
3056
|
|
@@ -2922,28 +3098,10 @@ KlaviyoAPI::Profiles.create_profile_merge(body)
|
|
2922
3098
|
|
2923
3099
|
|
2924
3100
|
|
2925
|
-
#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-10-15/reference/spawn_bulk_profile_import_job)
|
2926
|
-
|
2927
|
-
```ruby
|
2928
|
-
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2929
|
-
```
|
2930
|
-
##### Method alias:
|
2931
|
-
```ruby
|
2932
|
-
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
2933
|
-
```
|
2934
|
-
##### Method alias:
|
2935
|
-
```ruby
|
2936
|
-
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2937
|
-
```
|
2938
|
-
|
2939
|
-
|
2940
|
-
|
2941
|
-
|
2942
|
-
|
2943
3101
|
#### [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile)
|
2944
3102
|
|
2945
3103
|
```ruby
|
2946
|
-
KlaviyoAPI::Profiles.update_profile(id, body)
|
3104
|
+
KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
2947
3105
|
```
|
2948
3106
|
|
2949
3107
|
|
@@ -2963,6 +3121,10 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
2963
3121
|
```ruby
|
2964
3122
|
KlaviyoAPI::Reporting.create_campaign_value_report(body, opts)
|
2965
3123
|
```
|
3124
|
+
##### Method alias:
|
3125
|
+
```ruby
|
3126
|
+
KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
|
3127
|
+
```
|
2966
3128
|
|
2967
3129
|
|
2968
3130
|
|
@@ -2977,6 +3139,10 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
2977
3139
|
```ruby
|
2978
3140
|
KlaviyoAPI::Reporting.create_flow_sery_report(body, opts)
|
2979
3141
|
```
|
3142
|
+
##### Method alias:
|
3143
|
+
```ruby
|
3144
|
+
KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
|
3145
|
+
```
|
2980
3146
|
|
2981
3147
|
|
2982
3148
|
|
@@ -2991,6 +3157,10 @@ KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
|
2991
3157
|
```ruby
|
2992
3158
|
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
2993
3159
|
```
|
3160
|
+
##### Method alias:
|
3161
|
+
```ruby
|
3162
|
+
KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
|
3163
|
+
```
|
2994
3164
|
|
2995
3165
|
|
2996
3166
|
|
@@ -3005,6 +3175,10 @@ KlaviyoAPI::Reporting.query_form_series(body)
|
|
3005
3175
|
```ruby
|
3006
3176
|
KlaviyoAPI::Reporting.create_form_sery_report(body)
|
3007
3177
|
```
|
3178
|
+
##### Method alias:
|
3179
|
+
```ruby
|
3180
|
+
KlaviyoAPI::Reporting.create_form_series_report(body)
|
3181
|
+
```
|
3008
3182
|
|
3009
3183
|
|
3010
3184
|
|
@@ -3019,6 +3193,10 @@ KlaviyoAPI::Reporting.query_form_values(body)
|
|
3019
3193
|
```ruby
|
3020
3194
|
KlaviyoAPI::Reporting.create_form_value_report(body)
|
3021
3195
|
```
|
3196
|
+
##### Method alias:
|
3197
|
+
```ruby
|
3198
|
+
KlaviyoAPI::Reporting.create_form_values_report(body)
|
3199
|
+
```
|
3022
3200
|
|
3023
3201
|
|
3024
3202
|
|
@@ -3033,6 +3211,10 @@ KlaviyoAPI::Reporting.query_segment_series(body)
|
|
3033
3211
|
```ruby
|
3034
3212
|
KlaviyoAPI::Reporting.create_segment_sery_report(body)
|
3035
3213
|
```
|
3214
|
+
##### Method alias:
|
3215
|
+
```ruby
|
3216
|
+
KlaviyoAPI::Reporting.create_segment_series_report(body)
|
3217
|
+
```
|
3036
3218
|
|
3037
3219
|
|
3038
3220
|
|
@@ -3047,6 +3229,10 @@ KlaviyoAPI::Reporting.query_segment_values(body)
|
|
3047
3229
|
```ruby
|
3048
3230
|
KlaviyoAPI::Reporting.create_segment_value_report(body)
|
3049
3231
|
```
|
3232
|
+
##### Method alias:
|
3233
|
+
```ruby
|
3234
|
+
KlaviyoAPI::Reporting.create_segment_values_report(body)
|
3235
|
+
```
|
3050
3236
|
|
3051
3237
|
|
3052
3238
|
|
@@ -3100,58 +3286,74 @@ KlaviyoAPI::Segments.delete_segment(id)
|
|
3100
3286
|
|
3101
3287
|
|
3102
3288
|
|
3103
|
-
#### [Get
|
3289
|
+
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_segment)
|
3104
3290
|
|
3105
3291
|
```ruby
|
3106
|
-
KlaviyoAPI::Segments.
|
3292
|
+
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
|
3107
3293
|
```
|
3108
3294
|
##### Method alias:
|
3109
3295
|
```ruby
|
3110
|
-
KlaviyoAPI::Segments.
|
3296
|
+
KlaviyoAPI::Segments.get_flow_triggers_for_segment(id, opts)
|
3297
|
+
```
|
3298
|
+
##### Method alias:
|
3299
|
+
```ruby
|
3300
|
+
KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
3111
3301
|
```
|
3112
3302
|
|
3113
3303
|
|
3114
3304
|
|
3115
3305
|
|
3116
3306
|
|
3117
|
-
#### [Get
|
3307
|
+
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_segment)
|
3118
3308
|
|
3119
3309
|
```ruby
|
3120
|
-
KlaviyoAPI::Segments.
|
3310
|
+
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
|
3121
3311
|
```
|
3122
3312
|
##### Method alias:
|
3123
3313
|
```ruby
|
3124
|
-
KlaviyoAPI::Segments.
|
3314
|
+
KlaviyoAPI::Segments.get_flow_trigger_ids_for_segment(id)
|
3315
|
+
```
|
3316
|
+
##### Method alias:
|
3317
|
+
```ruby
|
3318
|
+
KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
3125
3319
|
```
|
3126
3320
|
|
3127
3321
|
|
3128
3322
|
|
3129
3323
|
|
3130
3324
|
|
3131
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
3325
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_segment)
|
3132
3326
|
|
3133
3327
|
```ruby
|
3134
|
-
KlaviyoAPI::Segments.
|
3328
|
+
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
3329
|
+
```
|
3330
|
+
##### Method alias:
|
3331
|
+
```ruby
|
3332
|
+
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
3135
3333
|
```
|
3136
3334
|
|
3137
3335
|
|
3138
3336
|
|
3139
3337
|
|
3140
3338
|
|
3141
|
-
#### [Get
|
3339
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_segment)
|
3142
3340
|
|
3143
3341
|
```ruby
|
3144
|
-
KlaviyoAPI::Segments.
|
3342
|
+
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
3343
|
+
```
|
3344
|
+
##### Method alias:
|
3345
|
+
```ruby
|
3346
|
+
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
3145
3347
|
```
|
3146
3348
|
|
3147
3349
|
|
3148
3350
|
|
3149
3351
|
|
3150
3352
|
|
3151
|
-
#### [Get Segment
|
3353
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment)
|
3152
3354
|
|
3153
3355
|
```ruby
|
3154
|
-
KlaviyoAPI::Segments.
|
3356
|
+
KlaviyoAPI::Segments.get_segment(id, opts)
|
3155
3357
|
```
|
3156
3358
|
|
3157
3359
|
|
@@ -3335,6 +3537,10 @@ KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
|
3335
3537
|
```ruby
|
3336
3538
|
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
3337
3539
|
```
|
3540
|
+
##### Method alias:
|
3541
|
+
```ruby
|
3542
|
+
KlaviyoAPI::Tags.get_group_for_tag(id, opts)
|
3543
|
+
```
|
3338
3544
|
|
3339
3545
|
|
3340
3546
|
|
@@ -3349,6 +3555,14 @@ KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
|
3349
3555
|
```ruby
|
3350
3556
|
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
3351
3557
|
```
|
3558
|
+
##### Method alias:
|
3559
|
+
```ruby
|
3560
|
+
KlaviyoAPI::Tags.get_group_id_for_tag(id)
|
3561
|
+
```
|
3562
|
+
##### Method alias:
|
3563
|
+
```ruby
|
3564
|
+
KlaviyoAPI::Tags.get_tag_relationships_group(id)
|
3565
|
+
```
|
3352
3566
|
|
3353
3567
|
|
3354
3568
|
|
@@ -3411,6 +3625,10 @@ KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
|
3411
3625
|
```ruby
|
3412
3626
|
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
3413
3627
|
```
|
3628
|
+
##### Method alias:
|
3629
|
+
```ruby
|
3630
|
+
KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
|
3631
|
+
```
|
3414
3632
|
|
3415
3633
|
|
3416
3634
|
|
@@ -3425,6 +3643,10 @@ KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
|
3425
3643
|
```ruby
|
3426
3644
|
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
3427
3645
|
```
|
3646
|
+
##### Method alias:
|
3647
|
+
```ruby
|
3648
|
+
KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
|
3649
|
+
```
|
3428
3650
|
|
3429
3651
|
|
3430
3652
|
|
@@ -3439,6 +3661,10 @@ KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
|
3439
3661
|
```ruby
|
3440
3662
|
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
3441
3663
|
```
|
3664
|
+
##### Method alias:
|
3665
|
+
```ruby
|
3666
|
+
KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
|
3667
|
+
```
|
3442
3668
|
|
3443
3669
|
|
3444
3670
|
|
@@ -3453,6 +3679,10 @@ KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
|
3453
3679
|
```ruby
|
3454
3680
|
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
3455
3681
|
```
|
3682
|
+
##### Method alias:
|
3683
|
+
```ruby
|
3684
|
+
KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
|
3685
|
+
```
|
3456
3686
|
|
3457
3687
|
|
3458
3688
|
|
@@ -3465,11 +3695,15 @@ KlaviyoAPI::Tags.tag_campaigns(id, body)
|
|
3465
3695
|
```
|
3466
3696
|
##### Method alias:
|
3467
3697
|
```ruby
|
3468
|
-
KlaviyoAPI::Tags.
|
3698
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body)
|
3469
3699
|
```
|
3470
3700
|
##### Method alias:
|
3471
3701
|
```ruby
|
3472
|
-
KlaviyoAPI::Tags.
|
3702
|
+
KlaviyoAPI::Tags.add_campaigns_to_tag(id, body)
|
3703
|
+
```
|
3704
|
+
##### Method alias:
|
3705
|
+
```ruby
|
3706
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
3473
3707
|
```
|
3474
3708
|
|
3475
3709
|
|
@@ -3483,11 +3717,15 @@ KlaviyoAPI::Tags.tag_flows(id, body)
|
|
3483
3717
|
```
|
3484
3718
|
##### Method alias:
|
3485
3719
|
```ruby
|
3486
|
-
KlaviyoAPI::Tags.
|
3720
|
+
KlaviyoAPI::Tags.create_tag_relationships_flow(id, body)
|
3487
3721
|
```
|
3488
3722
|
##### Method alias:
|
3489
3723
|
```ruby
|
3490
|
-
KlaviyoAPI::Tags.
|
3724
|
+
KlaviyoAPI::Tags.add_flows_to_tag(id, body)
|
3725
|
+
```
|
3726
|
+
##### Method alias:
|
3727
|
+
```ruby
|
3728
|
+
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
3491
3729
|
```
|
3492
3730
|
|
3493
3731
|
|
@@ -3501,11 +3739,15 @@ KlaviyoAPI::Tags.tag_lists(id, body)
|
|
3501
3739
|
```
|
3502
3740
|
##### Method alias:
|
3503
3741
|
```ruby
|
3504
|
-
KlaviyoAPI::Tags.
|
3742
|
+
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
|
3505
3743
|
```
|
3506
3744
|
##### Method alias:
|
3507
3745
|
```ruby
|
3508
|
-
KlaviyoAPI::Tags.
|
3746
|
+
KlaviyoAPI::Tags.add_lists_to_tag(id, body)
|
3747
|
+
```
|
3748
|
+
##### Method alias:
|
3749
|
+
```ruby
|
3750
|
+
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
3509
3751
|
```
|
3510
3752
|
|
3511
3753
|
|
@@ -3519,11 +3761,15 @@ KlaviyoAPI::Tags.tag_segments(id, body)
|
|
3519
3761
|
```
|
3520
3762
|
##### Method alias:
|
3521
3763
|
```ruby
|
3522
|
-
KlaviyoAPI::Tags.
|
3764
|
+
KlaviyoAPI::Tags.create_tag_relationships_segment(id, body)
|
3523
3765
|
```
|
3524
3766
|
##### Method alias:
|
3525
3767
|
```ruby
|
3526
|
-
KlaviyoAPI::Tags.
|
3768
|
+
KlaviyoAPI::Tags.add_segments_to_tag(id, body)
|
3769
|
+
```
|
3770
|
+
##### Method alias:
|
3771
|
+
```ruby
|
3772
|
+
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
3527
3773
|
```
|
3528
3774
|
|
3529
3775
|
|