klaviyo-api-sdk 1.2.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (765) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +654 -238
  4. data/klaviyo-api-sdk.gemspec +2 -2
  5. data/lib/klaviyo-api-sdk/api/accounts_api.rb +160 -0
  6. data/lib/klaviyo-api-sdk/api/campaigns_api.rb +101 -107
  7. data/lib/klaviyo-api-sdk/api/catalogs_api.rb +461 -549
  8. data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +4 -4
  9. data/lib/klaviyo-api-sdk/api/events_api.rb +132 -71
  10. data/lib/klaviyo-api-sdk/api/flows_api.rb +368 -206
  11. data/lib/klaviyo-api-sdk/api/lists_api.rb +172 -122
  12. data/lib/klaviyo-api-sdk/api/metrics_api.rb +18 -18
  13. data/lib/klaviyo-api-sdk/api/profiles_api.rb +173 -94
  14. data/lib/klaviyo-api-sdk/api/segments_api.rb +148 -76
  15. data/lib/klaviyo-api-sdk/api/tags_api.rb +932 -260
  16. data/lib/klaviyo-api-sdk/api/templates_api.rb +32 -32
  17. data/lib/klaviyo-api-sdk/api_client.rb +2 -2
  18. data/lib/klaviyo-api-sdk/api_error.rb +1 -1
  19. data/lib/klaviyo-api-sdk/configuration.rb +1 -1
  20. data/lib/klaviyo-api-sdk/models/audiences_sub_object.rb +1 -1
  21. data/lib/klaviyo-api-sdk/models/campaign_clone_query.rb +2 -2
  22. data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object.rb +238 -0
  23. data/lib/klaviyo-api-sdk/models/{campaign_clone_query_as_sub_resource_attributes.rb → campaign_clone_query_resource_object_attributes.rb} +18 -18
  24. data/lib/klaviyo-api-sdk/models/campaign_create_query.rb +2 -2
  25. data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +238 -0
  26. data/lib/klaviyo-api-sdk/models/{campaign_create_query_as_sub_resource_attributes.rb → campaign_create_query_resource_object_attributes.rb} +38 -38
  27. data/lib/klaviyo-api-sdk/models/campaign_enum.rb +36 -0
  28. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query.rb +2 -2
  29. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_resource_object.rb +238 -0
  30. data/lib/klaviyo-api-sdk/models/{campaign_message_assign_template_query_as_sub_resource_attributes.rb → campaign_message_assign_template_query_resource_object_attributes.rb} +4 -4
  31. data/lib/klaviyo-api-sdk/models/campaign_message_enum.rb +36 -0
  32. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query.rb +2 -2
  33. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object.rb +253 -0
  34. data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_as_sub_resource_attributes.rb → campaign_message_partial_update_query_resource_object_attributes.rb} +17 -17
  35. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query.rb +2 -2
  36. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +253 -0
  37. data/lib/klaviyo-api-sdk/models/{campaign_partial_update_query_as_sub_resource_attributes.rb → campaign_partial_update_query_resource_object_attributes.rb} +30 -30
  38. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query.rb +2 -2
  39. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_resource_object.rb +238 -0
  40. data/lib/klaviyo-api-sdk/models/{campaign_recipient_estimation_job_create_query_as_sub_resource_attributes.rb → campaign_recipient_estimation_job_create_query_resource_object_attributes.rb} +4 -4
  41. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_enum.rb +36 -0
  42. data/lib/klaviyo-api-sdk/models/campaign_send_job_create_query.rb +2 -2
  43. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner_source.rb → campaign_send_job_create_query_resource_object.rb} +27 -17
  44. data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource_attributes.rb → campaign_send_job_create_query_resource_object_attributes.rb} +4 -4
  45. data/lib/klaviyo-api-sdk/models/campaign_send_job_enum.rb +36 -0
  46. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query.rb +2 -2
  47. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object.rb +253 -0
  48. data/lib/klaviyo-api-sdk/models/{campaign_send_job_partial_update_query_as_sub_resource_attributes.rb → campaign_send_job_partial_update_query_resource_object_attributes.rb} +4 -4
  49. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_create_job_enum.rb +36 -0
  50. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_delete_job_enum.rb +36 -0
  51. data/lib/klaviyo-api-sdk/models/catalog_category_bulk_update_job_enum.rb +36 -0
  52. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query.rb +2 -2
  53. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_resource_object.rb +238 -0
  54. data/lib/klaviyo-api-sdk/models/{catalog_category_create_job_create_query_as_sub_resource_attributes.rb → catalog_category_create_job_create_query_resource_object_attributes.rb} +5 -5
  55. data/lib/klaviyo-api-sdk/models/catalog_category_create_query.rb +2 -2
  56. data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource.rb → catalog_category_create_query_resource_object.rb} +27 -52
  57. data/lib/klaviyo-api-sdk/models/{catalog_category_create_query_as_sub_resource_attributes.rb → catalog_category_create_query_resource_object_attributes.rb} +20 -20
  58. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query.rb +2 -2
  59. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_resource_object.rb +238 -0
  60. data/lib/klaviyo-api-sdk/models/{catalog_category_delete_job_create_query_as_sub_resource_attributes.rb → catalog_category_delete_job_create_query_resource_object_attributes.rb} +5 -5
  61. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_resource_object.rb +239 -0
  62. data/lib/klaviyo-api-sdk/models/catalog_category_enum.rb +36 -0
  63. data/lib/klaviyo-api-sdk/models/catalog_category_item_op.rb +2 -2
  64. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query.rb +2 -2
  65. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_resource_object.rb +238 -0
  66. data/lib/klaviyo-api-sdk/models/{catalog_category_update_job_create_query_as_sub_resource_attributes.rb → catalog_category_update_job_create_query_resource_object_attributes.rb} +5 -5
  67. data/lib/klaviyo-api-sdk/models/catalog_category_update_query.rb +2 -2
  68. data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource.rb → catalog_category_update_query_resource_object.rb} +37 -47
  69. data/lib/klaviyo-api-sdk/models/{catalog_category_update_query_as_sub_resource_attributes.rb → catalog_category_update_query_resource_object_attributes.rb} +4 -4
  70. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships.rb → catalog_category_update_query_resource_object_relationships.rb} +5 -5
  71. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories.rb → catalog_category_update_query_resource_object_relationships_items.rb} +5 -5
  72. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships_categories_data_inner.rb → catalog_category_update_query_resource_object_relationships_items_data_inner.rb} +6 -6
  73. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_create_job_enum.rb +36 -0
  74. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_delete_job_enum.rb +36 -0
  75. data/lib/klaviyo-api-sdk/models/catalog_item_bulk_update_job_enum.rb +36 -0
  76. data/lib/klaviyo-api-sdk/models/catalog_item_category_op.rb +2 -2
  77. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items_data_inner.rb → catalog_item_category_op_data_inner.rb} +6 -6
  78. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query.rb +2 -2
  79. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_resource_object.rb +238 -0
  80. data/lib/klaviyo-api-sdk/models/{catalog_item_create_job_create_query_as_sub_resource_attributes.rb → catalog_item_create_job_create_query_resource_object_attributes.rb} +5 -5
  81. data/lib/klaviyo-api-sdk/models/catalog_item_create_query.rb +2 -2
  82. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_resource_object.rb +247 -0
  83. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_attributes.rb → catalog_item_create_query_resource_object_attributes.rb} +74 -74
  84. data/lib/klaviyo-api-sdk/models/{catalog_item_create_query_as_sub_resource_relationships.rb → catalog_item_create_query_resource_object_relationships.rb} +5 -5
  85. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_relationships_items.rb → catalog_item_create_query_resource_object_relationships_categories.rb} +5 -5
  86. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query.rb +2 -2
  87. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_resource_object.rb +238 -0
  88. data/lib/klaviyo-api-sdk/models/{catalog_item_delete_job_create_query_as_sub_resource_attributes.rb → catalog_item_delete_job_create_query_resource_object_attributes.rb} +5 -5
  89. data/lib/klaviyo-api-sdk/models/catalog_item_delete_query_resource_object.rb +239 -0
  90. data/lib/klaviyo-api-sdk/models/catalog_item_enum.rb +36 -0
  91. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query.rb +2 -2
  92. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_resource_object.rb +238 -0
  93. data/lib/klaviyo-api-sdk/models/{catalog_item_update_job_create_query_as_sub_resource_attributes.rb → catalog_item_update_job_create_query_resource_object_attributes.rb} +5 -5
  94. data/lib/klaviyo-api-sdk/models/catalog_item_update_query.rb +2 -2
  95. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_resource_object.rb +262 -0
  96. data/lib/klaviyo-api-sdk/models/{catalog_item_update_query_as_sub_resource_attributes.rb → catalog_item_update_query_resource_object_attributes.rb} +46 -46
  97. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_create_job_enum.rb +36 -0
  98. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_delete_job_enum.rb +36 -0
  99. data/lib/klaviyo-api-sdk/models/catalog_variant_bulk_update_job_enum.rb +36 -0
  100. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query.rb +2 -2
  101. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_resource_object.rb +238 -0
  102. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_job_create_query_as_sub_resource_attributes.rb → catalog_variant_create_job_create_query_resource_object_attributes.rb} +5 -5
  103. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query.rb +2 -2
  104. data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource.rb → catalog_variant_create_query_resource_object.rb} +27 -52
  105. data/lib/klaviyo-api-sdk/models/{catalog_variant_create_query_as_sub_resource_attributes.rb → catalog_variant_create_query_resource_object_attributes.rb} +117 -117
  106. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query.rb +2 -2
  107. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_resource_object.rb +238 -0
  108. data/lib/klaviyo-api-sdk/models/{catalog_variant_delete_job_create_query_as_sub_resource_attributes.rb → catalog_variant_delete_job_create_query_resource_object_attributes.rb} +5 -5
  109. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_resource_object.rb +239 -0
  110. data/lib/klaviyo-api-sdk/models/catalog_variant_enum.rb +36 -0
  111. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query.rb +2 -2
  112. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_resource_object.rb +238 -0
  113. data/lib/klaviyo-api-sdk/models/{catalog_variant_update_job_create_query_as_sub_resource_attributes.rb → catalog_variant_update_job_create_query_resource_object_attributes.rb} +5 -5
  114. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query.rb +2 -2
  115. data/lib/klaviyo-api-sdk/models/{campaign_send_job_create_query_as_sub_resource.rb → catalog_variant_update_query_resource_object.rb} +29 -48
  116. data/lib/klaviyo-api-sdk/models/{catalog_variant_update_query_as_sub_resource_attributes.rb → catalog_variant_update_query_resource_object_attributes.rb} +63 -53
  117. data/lib/klaviyo-api-sdk/models/content_sub_object.rb +30 -30
  118. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query.rb +2 -2
  119. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_resource_object.rb +238 -0
  120. data/lib/klaviyo-api-sdk/models/{data_privacy_create_deletion_job_query_as_sub_resource_attributes.rb → data_privacy_create_deletion_job_query_resource_object_attributes.rb} +18 -18
  121. data/lib/klaviyo-api-sdk/models/data_privacy_deletion_job_enum.rb +36 -0
  122. data/lib/klaviyo-api-sdk/models/event_create_query.rb +2 -2
  123. data/lib/klaviyo-api-sdk/models/event_create_query_resource_object.rb +238 -0
  124. data/lib/klaviyo-api-sdk/models/{event_create_query_as_sub_resource_attributes.rb → event_create_query_resource_object_attributes.rb} +19 -19
  125. data/lib/klaviyo-api-sdk/models/event_enum.rb +36 -0
  126. data/lib/klaviyo-api-sdk/models/flow_enum.rb +36 -0
  127. data/lib/klaviyo-api-sdk/models/flow_update_query.rb +2 -2
  128. data/lib/klaviyo-api-sdk/models/flow_update_query_resource_object.rb +253 -0
  129. data/lib/klaviyo-api-sdk/models/{flow_update_query_as_sub_resource_attributes.rb → flow_update_query_resource_object_attributes.rb} +5 -4
  130. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response.rb → get_create_variants_jobs5_xx_response.rb} +5 -5
  131. data/lib/klaviyo-api-sdk/models/{get_campaigns4_xx_response_errors_inner.rb → get_create_variants_jobs5_xx_response_errors_inner.rb} +40 -40
  132. data/lib/klaviyo-api-sdk/models/{get_catalog_items4_xx_response_errors_inner_source.rb → get_create_variants_jobs5_xx_response_errors_inner_source.rb} +17 -17
  133. data/lib/klaviyo-api-sdk/models/list_create_query.rb +2 -2
  134. data/lib/klaviyo-api-sdk/models/{sms_message_content.rb → list_create_query_resource_object.rb} +23 -23
  135. data/lib/klaviyo-api-sdk/models/{segment_partial_update_query_as_sub_resource_attributes.rb → list_create_query_resource_object_attributes.rb} +5 -4
  136. data/lib/klaviyo-api-sdk/models/list_enum.rb +36 -0
  137. data/lib/klaviyo-api-sdk/models/list_members_add_query.rb +1 -1
  138. data/lib/klaviyo-api-sdk/models/list_members_add_query_data_inner.rb +1 -1
  139. data/lib/klaviyo-api-sdk/models/list_members_delete_query.rb +1 -1
  140. data/lib/klaviyo-api-sdk/models/list_partial_update_query.rb +2 -2
  141. data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +253 -0
  142. data/lib/klaviyo-api-sdk/models/metric_aggregate_enum.rb +36 -0
  143. data/lib/klaviyo-api-sdk/models/metric_aggregate_query.rb +2 -2
  144. data/lib/klaviyo-api-sdk/models/{v2_template_render_query_as_sub_resource.rb → metric_aggregate_query_resource_object.rb} +30 -13
  145. data/lib/klaviyo-api-sdk/models/{metric_aggregate_query_as_sub_resource_attributes.rb → metric_aggregate_query_resource_object_attributes.rb} +70 -70
  146. data/lib/klaviyo-api-sdk/models/metric_create_query.rb +1 -1
  147. data/lib/klaviyo-api-sdk/models/profile_create_query.rb +2 -2
  148. data/lib/klaviyo-api-sdk/models/profile_create_query_resource_object.rb +238 -0
  149. data/lib/klaviyo-api-sdk/models/{included_profiles_attributes.rb → profile_create_query_resource_object_attributes.rb} +36 -75
  150. data/lib/klaviyo-api-sdk/models/profile_enum.rb +36 -0
  151. data/lib/klaviyo-api-sdk/models/profile_location.rb +38 -38
  152. data/lib/klaviyo-api-sdk/models/profile_location_latitude.rb +1 -1
  153. data/lib/klaviyo-api-sdk/models/profile_location_longitude.rb +1 -1
  154. data/lib/klaviyo-api-sdk/models/profile_partial_update_query.rb +2 -2
  155. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +253 -0
  156. data/lib/klaviyo-api-sdk/models/{profile_create_query_as_sub_resource_attributes.rb → profile_partial_update_query_resource_object_attributes.rb} +48 -48
  157. data/lib/klaviyo-api-sdk/models/profile_subscription_bulk_create_job_enum.rb +36 -0
  158. data/lib/klaviyo-api-sdk/models/profile_suppression_bulk_create_job_enum.rb +36 -0
  159. data/lib/klaviyo-api-sdk/models/profile_unsubscription_bulk_create_job_enum.rb +36 -0
  160. data/lib/klaviyo-api-sdk/models/profile_unsuppression_bulk_create_job_enum.rb +36 -0
  161. data/lib/klaviyo-api-sdk/models/segment_enum.rb +36 -0
  162. data/lib/klaviyo-api-sdk/models/segment_partial_update_query.rb +2 -2
  163. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_resource_object.rb +252 -0
  164. data/lib/klaviyo-api-sdk/models/{tag_update_query_as_sub_resource_attributes.rb → segment_partial_update_query_resource_object_attributes.rb} +4 -5
  165. data/lib/klaviyo-api-sdk/models/send_options_sub_object.rb +1 -1
  166. data/lib/klaviyo-api-sdk/models/send_strategy_sub_object.rb +17 -17
  167. data/lib/klaviyo-api-sdk/models/static_schedule_options.rb +15 -15
  168. data/lib/klaviyo-api-sdk/models/sto_schedule_options.rb +1 -1
  169. data/lib/klaviyo-api-sdk/models/subscription.rb +15 -15
  170. data/lib/klaviyo-api-sdk/models/subscription_channels.rb +17 -17
  171. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query.rb +2 -2
  172. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_resource_object.rb +238 -0
  173. data/lib/klaviyo-api-sdk/models/{subscription_create_job_create_query_as_sub_resource_attributes.rb → subscription_create_job_create_query_resource_object_attributes.rb} +26 -26
  174. data/lib/klaviyo-api-sdk/models/suppression.rb +1 -1
  175. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query.rb +2 -2
  176. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_resource_object.rb +238 -0
  177. data/lib/klaviyo-api-sdk/models/{suppression_create_job_create_query_as_sub_resource_attributes.rb → suppression_create_job_create_query_resource_object_attributes.rb} +4 -4
  178. data/lib/klaviyo-api-sdk/models/{campaign_tag_op.rb → tag_campaign_op.rb} +5 -5
  179. data/lib/klaviyo-api-sdk/models/{campaign_tag_op_data_inner.rb → tag_campaign_op_data_inner.rb} +6 -6
  180. data/lib/klaviyo-api-sdk/models/tag_create_query.rb +2 -2
  181. data/lib/klaviyo-api-sdk/models/{utm_param_info.rb → tag_create_query_resource_object.rb} +23 -23
  182. data/lib/klaviyo-api-sdk/models/{tag_create_query_as_sub_resource_attributes.rb → tag_create_query_resource_object_attributes.rb} +18 -18
  183. data/lib/klaviyo-api-sdk/models/tag_enum.rb +36 -0
  184. data/lib/klaviyo-api-sdk/models/{onsite_profile_create_query.rb → tag_flow_op.rb} +8 -6
  185. data/lib/klaviyo-api-sdk/models/{catalog_item_delete_query_as_sub_resource.rb → tag_flow_op_data_inner.rb} +6 -7
  186. data/lib/klaviyo-api-sdk/models/tag_group_create_query.rb +2 -2
  187. data/lib/klaviyo-api-sdk/models/tag_group_create_query_resource_object.rb +238 -0
  188. data/lib/klaviyo-api-sdk/models/{tag_group_create_query_as_sub_resource_attributes.rb → tag_group_create_query_resource_object_attributes.rb} +17 -17
  189. data/lib/klaviyo-api-sdk/models/tag_group_enum.rb +36 -0
  190. data/lib/klaviyo-api-sdk/models/tag_group_update_query.rb +2 -2
  191. data/lib/klaviyo-api-sdk/models/tag_group_update_query_resource_object.rb +253 -0
  192. data/lib/klaviyo-api-sdk/models/{tag_group_update_query_as_sub_resource_attributes.rb → tag_group_update_query_resource_object_attributes.rb} +17 -17
  193. data/lib/klaviyo-api-sdk/models/{onsite_subscription_create_query.rb → tag_list_op.rb} +8 -6
  194. data/lib/klaviyo-api-sdk/models/tag_list_op_data_inner.rb +272 -0
  195. data/lib/klaviyo-api-sdk/models/tag_segment_op.rb +1 -1
  196. data/lib/klaviyo-api-sdk/models/tag_segment_op_data_inner.rb +1 -1
  197. data/lib/klaviyo-api-sdk/models/tag_update_query.rb +2 -2
  198. data/lib/klaviyo-api-sdk/models/tag_update_query_resource_object.rb +253 -0
  199. data/lib/klaviyo-api-sdk/models/{list_create_query_as_sub_resource_attributes.rb → tag_update_query_resource_object_attributes.rb} +5 -5
  200. data/lib/klaviyo-api-sdk/models/template_clone_query.rb +2 -2
  201. data/lib/klaviyo-api-sdk/models/template_clone_query_resource_object.rb +238 -0
  202. data/lib/klaviyo-api-sdk/models/{template_clone_query_as_sub_resource_attributes.rb → template_clone_query_resource_object_attributes.rb} +20 -20
  203. data/lib/klaviyo-api-sdk/models/template_create_query.rb +2 -2
  204. data/lib/klaviyo-api-sdk/models/template_create_query_resource_object.rb +238 -0
  205. data/lib/klaviyo-api-sdk/models/{template_create_query_as_sub_resource_attributes.rb → template_create_query_resource_object_attributes.rb} +35 -35
  206. data/lib/klaviyo-api-sdk/models/template_enum.rb +36 -0
  207. data/lib/klaviyo-api-sdk/models/template_render_query.rb +2 -2
  208. data/lib/klaviyo-api-sdk/models/template_render_query_resource_object.rb +238 -0
  209. data/lib/klaviyo-api-sdk/models/{template_render_query_as_sub_resource_attributes.rb → template_render_query_resource_object_attributes.rb} +20 -20
  210. data/lib/klaviyo-api-sdk/models/template_update_query.rb +2 -2
  211. data/lib/klaviyo-api-sdk/models/template_update_query_resource_object.rb +253 -0
  212. data/lib/klaviyo-api-sdk/models/{template_update_query_as_sub_resource_attributes.rb → template_update_query_resource_object_attributes.rb} +19 -19
  213. data/lib/klaviyo-api-sdk/models/throttled_schedule_options.rb +20 -20
  214. data/lib/klaviyo-api-sdk/models/tracking_options_sub_object.rb +15 -15
  215. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query.rb +2 -2
  216. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_resource_object.rb +238 -0
  217. data/lib/klaviyo-api-sdk/models/{unsubscription_create_job_create_query_as_sub_resource_attributes.rb → unsubscription_create_job_create_query_resource_object_attributes.rb} +21 -21
  218. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query.rb +2 -2
  219. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_resource_object.rb +238 -0
  220. data/lib/klaviyo-api-sdk/models/{unsuppression_create_job_create_query_as_sub_resource_attributes.rb → unsuppression_create_job_create_query_resource_object_attributes.rb} +4 -4
  221. data/lib/klaviyo-api-sdk/models/utm_params_sub_object.rb +1 -1
  222. data/lib/klaviyo-api-sdk/version.rb +1 -1
  223. data/lib/klaviyo-api-sdk.rb +137 -143
  224. metadata +139 -609
  225. data/Gemfile +0 -9
  226. data/Rakefile +0 -10
  227. data/docs/AudiencesSubObject.md +0 -20
  228. data/docs/CampaignCloneQuery.md +0 -18
  229. data/docs/CampaignCloneQueryAsSubResource.md +0 -20
  230. data/docs/CampaignCloneQueryAsSubResourceAttributes.md +0 -20
  231. data/docs/CampaignCreateQuery.md +0 -18
  232. data/docs/CampaignCreateQueryAsSubResource.md +0 -20
  233. data/docs/CampaignCreateQueryAsSubResourceAttributes.md +0 -28
  234. data/docs/CampaignMessageAssignTemplateQuery.md +0 -18
  235. data/docs/CampaignMessageAssignTemplateQueryAsSubResource.md +0 -20
  236. data/docs/CampaignMessageAssignTemplateQueryAsSubResourceAttributes.md +0 -20
  237. data/docs/CampaignMessagePartialUpdateQuery.md +0 -18
  238. data/docs/CampaignMessagePartialUpdateQueryAsSubResource.md +0 -22
  239. data/docs/CampaignMessagePartialUpdateQueryAsSubResourceAttributes.md +0 -20
  240. data/docs/CampaignPartialUpdateQuery.md +0 -18
  241. data/docs/CampaignPartialUpdateQueryAsSubResource.md +0 -22
  242. data/docs/CampaignPartialUpdateQueryAsSubResourceAttributes.md +0 -26
  243. data/docs/CampaignRecipientEstimationJobCreateQuery.md +0 -18
  244. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResource.md +0 -20
  245. data/docs/CampaignRecipientEstimationJobCreateQueryAsSubResourceAttributes.md +0 -18
  246. data/docs/CampaignSendJobCreateQuery.md +0 -18
  247. data/docs/CampaignSendJobCreateQueryAsSubResource.md +0 -20
  248. data/docs/CampaignSendJobCreateQueryAsSubResourceAttributes.md +0 -18
  249. data/docs/CampaignSendJobPartialUpdateQuery.md +0 -18
  250. data/docs/CampaignSendJobPartialUpdateQueryAsSubResource.md +0 -22
  251. data/docs/CampaignSendJobPartialUpdateQueryAsSubResourceAttributes.md +0 -18
  252. data/docs/CampaignTagOp.md +0 -18
  253. data/docs/CampaignTagOpDataInner.md +0 -20
  254. data/docs/CampaignsApi.md +0 -1277
  255. data/docs/CatalogCategoryCreateJobCreateQuery.md +0 -18
  256. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResource.md +0 -20
  257. data/docs/CatalogCategoryCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  258. data/docs/CatalogCategoryCreateQuery.md +0 -18
  259. data/docs/CatalogCategoryCreateQueryAsSubResource.md +0 -22
  260. data/docs/CatalogCategoryCreateQueryAsSubResourceAttributes.md +0 -24
  261. data/docs/CatalogCategoryDeleteJobCreateQuery.md +0 -18
  262. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResource.md +0 -20
  263. data/docs/CatalogCategoryDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  264. data/docs/CatalogCategoryDeleteQueryAsSubResource.md +0 -20
  265. data/docs/CatalogCategoryItemOp.md +0 -18
  266. data/docs/CatalogCategoryUpdateJobCreateQuery.md +0 -18
  267. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResource.md +0 -20
  268. data/docs/CatalogCategoryUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  269. data/docs/CatalogCategoryUpdateQuery.md +0 -18
  270. data/docs/CatalogCategoryUpdateQueryAsSubResource.md +0 -24
  271. data/docs/CatalogCategoryUpdateQueryAsSubResourceAttributes.md +0 -18
  272. data/docs/CatalogItemCategoryOp.md +0 -18
  273. data/docs/CatalogItemCreateJobCreateQuery.md +0 -18
  274. data/docs/CatalogItemCreateJobCreateQueryAsSubResource.md +0 -20
  275. data/docs/CatalogItemCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  276. data/docs/CatalogItemCreateQuery.md +0 -18
  277. data/docs/CatalogItemCreateQueryAsSubResource.md +0 -22
  278. data/docs/CatalogItemCreateQueryAsSubResourceAttributes.md +0 -40
  279. data/docs/CatalogItemCreateQueryAsSubResourceRelationships.md +0 -18
  280. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategories.md +0 -18
  281. data/docs/CatalogItemCreateQueryAsSubResourceRelationshipsCategoriesDataInner.md +0 -20
  282. data/docs/CatalogItemDeleteJobCreateQuery.md +0 -18
  283. data/docs/CatalogItemDeleteJobCreateQueryAsSubResource.md +0 -20
  284. data/docs/CatalogItemDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  285. data/docs/CatalogItemDeleteQueryAsSubResource.md +0 -20
  286. data/docs/CatalogItemUpdateJobCreateQuery.md +0 -18
  287. data/docs/CatalogItemUpdateJobCreateQueryAsSubResource.md +0 -20
  288. data/docs/CatalogItemUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  289. data/docs/CatalogItemUpdateQuery.md +0 -18
  290. data/docs/CatalogItemUpdateQueryAsSubResource.md +0 -24
  291. data/docs/CatalogItemUpdateQueryAsSubResourceAttributes.md +0 -34
  292. data/docs/CatalogJobErrorPayload.md +0 -26
  293. data/docs/CatalogVariantCreateJobCreateQuery.md +0 -18
  294. data/docs/CatalogVariantCreateJobCreateQueryAsSubResource.md +0 -20
  295. data/docs/CatalogVariantCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  296. data/docs/CatalogVariantCreateQuery.md +0 -18
  297. data/docs/CatalogVariantCreateQueryAsSubResource.md +0 -22
  298. data/docs/CatalogVariantCreateQueryAsSubResourceAttributes.md +0 -46
  299. data/docs/CatalogVariantCreateQueryAsSubResourceRelationships.md +0 -18
  300. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItems.md +0 -18
  301. data/docs/CatalogVariantCreateQueryAsSubResourceRelationshipsItemsDataInner.md +0 -20
  302. data/docs/CatalogVariantDeleteJobCreateQuery.md +0 -18
  303. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResource.md +0 -20
  304. data/docs/CatalogVariantDeleteJobCreateQueryAsSubResourceAttributes.md +0 -18
  305. data/docs/CatalogVariantDeleteQueryAsSubResource.md +0 -20
  306. data/docs/CatalogVariantUpdateJobCreateQuery.md +0 -18
  307. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResource.md +0 -20
  308. data/docs/CatalogVariantUpdateJobCreateQueryAsSubResourceAttributes.md +0 -18
  309. data/docs/CatalogVariantUpdateQuery.md +0 -18
  310. data/docs/CatalogVariantUpdateQueryAsSubResource.md +0 -22
  311. data/docs/CatalogVariantUpdateQueryAsSubResourceAttributes.md +0 -38
  312. data/docs/CatalogsApi.md +0 -4048
  313. data/docs/ClientApi.md +0 -205
  314. data/docs/ContentSubObject.md +0 -28
  315. data/docs/DataPrivacyApi.md +0 -78
  316. data/docs/DataPrivacyCreateDeletionJobQuery.md +0 -18
  317. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResource.md +0 -20
  318. data/docs/DataPrivacyCreateDeletionJobQueryAsSubResourceAttributes.md +0 -22
  319. data/docs/EmailMessageContent.md +0 -24
  320. data/docs/EmailTrackingOptions.md +0 -24
  321. data/docs/ErrorSource.md +0 -18
  322. data/docs/EventCreateQuery.md +0 -18
  323. data/docs/EventCreateQueryAsSubResource.md +0 -20
  324. data/docs/EventCreateQueryAsSubResourceAttributes.md +0 -28
  325. data/docs/EventsApi.md +0 -472
  326. data/docs/FlowUpdateQuery.md +0 -18
  327. data/docs/FlowUpdateQueryAsSubResource.md +0 -22
  328. data/docs/FlowUpdateQueryAsSubResourceAttributes.md +0 -18
  329. data/docs/FlowsApi.md +0 -1029
  330. data/docs/GetCampaigns4XXResponse.md +0 -18
  331. data/docs/GetCampaigns4XXResponseErrorsInner.md +0 -26
  332. data/docs/GetCampaigns4XXResponseErrorsInnerSource.md +0 -20
  333. data/docs/GetCatalogItems4XXResponse.md +0 -18
  334. data/docs/GetCatalogItems4XXResponseErrorsInner.md +0 -26
  335. data/docs/GetCatalogItems4XXResponseErrorsInnerSource.md +0 -20
  336. data/docs/IncludedCategories.md +0 -24
  337. data/docs/IncludedCategoriesAttributes.md +0 -22
  338. data/docs/IncludedFlowAction.md +0 -24
  339. data/docs/IncludedFlowActions.md +0 -24
  340. data/docs/IncludedFlowActionsAttributes.md +0 -32
  341. data/docs/IncludedFlowActionsAttributesTrackingOptions.md +0 -49
  342. data/docs/IncludedFlowMessages.md +0 -24
  343. data/docs/IncludedFlowMessagesAttributes.md +0 -26
  344. data/docs/IncludedFlowMessagesAttributesContent.md +0 -49
  345. data/docs/IncludedFlows.md +0 -24
  346. data/docs/IncludedFlowsAttributes.md +0 -28
  347. data/docs/IncludedItems.md +0 -24
  348. data/docs/IncludedItemsAttributes.md +0 -40
  349. data/docs/IncludedLists.md +0 -24
  350. data/docs/IncludedListsAttributes.md +0 -22
  351. data/docs/IncludedMetrics.md +0 -24
  352. data/docs/IncludedMetricsAttributes.md +0 -24
  353. data/docs/IncludedProfiles.md +0 -24
  354. data/docs/IncludedProfilesAttributes.md +0 -44
  355. data/docs/IncludedSegments.md +0 -24
  356. data/docs/IncludedSegmentsAttributes.md +0 -22
  357. data/docs/IncludedTags.md +0 -24
  358. data/docs/IncludedVariants.md +0 -24
  359. data/docs/IncludedVariantsAttributes.md +0 -46
  360. data/docs/IncludedVariantsLinks.md +0 -18
  361. data/docs/ListCreateQuery.md +0 -18
  362. data/docs/ListCreateQueryAsSubResource.md +0 -20
  363. data/docs/ListCreateQueryAsSubResourceAttributes.md +0 -18
  364. data/docs/ListMembersAddQuery.md +0 -18
  365. data/docs/ListMembersAddQueryDataInner.md +0 -20
  366. data/docs/ListMembersDeleteQuery.md +0 -18
  367. data/docs/ListPartialUpdateQuery.md +0 -18
  368. data/docs/ListPartialUpdateQueryAsSubResource.md +0 -22
  369. data/docs/ListsApi.md +0 -762
  370. data/docs/MetricAggregateQuery.md +0 -18
  371. data/docs/MetricAggregateQueryAsSubResource.md +0 -20
  372. data/docs/MetricAggregateQueryAsSubResourceAttributes.md +0 -36
  373. data/docs/MetricAggregateRowDTO.md +0 -20
  374. data/docs/MetricCreateQuery.md +0 -20
  375. data/docs/MetricsApi.md +0 -233
  376. data/docs/OnsiteProfileCreateQuery.md +0 -18
  377. data/docs/OnsiteProfileCreateQueryAsSubResource.md +0 -22
  378. data/docs/OnsiteProfileMeta.md +0 -18
  379. data/docs/OnsiteProfileMetaIdentifiers.md +0 -28
  380. data/docs/OnsiteSubscriptionCreateQuery.md +0 -18
  381. data/docs/OnsiteSubscriptionCreateQueryAsSubResource.md +0 -20
  382. data/docs/OnsiteSubscriptionCreateQueryAsSubResourceAttributes.md +0 -26
  383. data/docs/ProfileCreateQuery.md +0 -18
  384. data/docs/ProfileCreateQueryAsSubResource.md +0 -20
  385. data/docs/ProfileCreateQueryAsSubResourceAttributes.md +0 -38
  386. data/docs/ProfileLocation.md +0 -34
  387. data/docs/ProfileLocationLatitude.md +0 -49
  388. data/docs/ProfileLocationLongitude.md +0 -49
  389. data/docs/ProfilePartialUpdateQuery.md +0 -18
  390. data/docs/ProfilePartialUpdateQueryAsSubResource.md +0 -22
  391. data/docs/ProfilesApi.md +0 -825
  392. data/docs/SMSMessageContent.md +0 -20
  393. data/docs/SMSRenderOptions.md +0 -24
  394. data/docs/SMSTrackingOptions.md +0 -20
  395. data/docs/STOScheduleOptions.md +0 -18
  396. data/docs/SegmentPartialUpdateQuery.md +0 -18
  397. data/docs/SegmentPartialUpdateQueryAsSubResource.md +0 -22
  398. data/docs/SegmentPartialUpdateQueryAsSubResourceAttributes.md +0 -18
  399. data/docs/SegmentsApi.md +0 -469
  400. data/docs/SendOptions.md +0 -20
  401. data/docs/SendOptionsSubObject.md +0 -18
  402. data/docs/SendStrategySubObject.md +0 -24
  403. data/docs/SendTimeSubObject.md +0 -20
  404. data/docs/StaticScheduleOptions.md +0 -22
  405. data/docs/Subscription.md +0 -24
  406. data/docs/SubscriptionChannels.md +0 -20
  407. data/docs/SubscriptionCreateJobCreateQuery.md +0 -18
  408. data/docs/SubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  409. data/docs/SubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  410. data/docs/Suppression.md +0 -18
  411. data/docs/SuppressionCreateJobCreateQuery.md +0 -18
  412. data/docs/SuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  413. data/docs/SuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  414. data/docs/TagCreateQuery.md +0 -18
  415. data/docs/TagCreateQueryAsSubResource.md +0 -20
  416. data/docs/TagCreateQueryAsSubResourceAttributes.md +0 -20
  417. data/docs/TagGroupCreateQuery.md +0 -18
  418. data/docs/TagGroupCreateQueryAsSubResource.md +0 -20
  419. data/docs/TagGroupCreateQueryAsSubResourceAttributes.md +0 -20
  420. data/docs/TagGroupUpdateQuery.md +0 -18
  421. data/docs/TagGroupUpdateQueryAsSubResource.md +0 -22
  422. data/docs/TagGroupUpdateQueryAsSubResourceAttributes.md +0 -20
  423. data/docs/TagSegmentOp.md +0 -18
  424. data/docs/TagSegmentOpDataInner.md +0 -20
  425. data/docs/TagUpdateQuery.md +0 -18
  426. data/docs/TagUpdateQueryAsSubResource.md +0 -22
  427. data/docs/TagUpdateQueryAsSubResourceAttributes.md +0 -18
  428. data/docs/TagsApi.md +0 -1205
  429. data/docs/TemplateCloneQuery.md +0 -18
  430. data/docs/TemplateCloneQueryAsSubResource.md +0 -20
  431. data/docs/TemplateCloneQueryAsSubResourceAttributes.md +0 -22
  432. data/docs/TemplateCreateQuery.md +0 -18
  433. data/docs/TemplateCreateQueryAsSubResource.md +0 -20
  434. data/docs/TemplateCreateQueryAsSubResourceAttributes.md +0 -32
  435. data/docs/TemplateRenderQuery.md +0 -18
  436. data/docs/TemplateRenderQueryAsSubResource.md +0 -20
  437. data/docs/TemplateRenderQueryAsSubResourceAttributes.md +0 -22
  438. data/docs/TemplateUpdateQuery.md +0 -18
  439. data/docs/TemplateUpdateQueryAsSubResource.md +0 -22
  440. data/docs/TemplateUpdateQueryAsSubResourceAttributes.md +0 -30
  441. data/docs/TemplatesApi.md +0 -525
  442. data/docs/ThrottledScheduleOptions.md +0 -20
  443. data/docs/TrackingOptionsSubObject.md +0 -24
  444. data/docs/UTMParamsSubObject.md +0 -20
  445. data/docs/UnsubscriptionCreateJobCreateQuery.md +0 -18
  446. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResource.md +0 -20
  447. data/docs/UnsubscriptionCreateJobCreateQueryAsSubResourceAttributes.md +0 -22
  448. data/docs/UnsuppressionCreateJobCreateQuery.md +0 -18
  449. data/docs/UnsuppressionCreateJobCreateQueryAsSubResource.md +0 -20
  450. data/docs/UnsuppressionCreateJobCreateQueryAsSubResourceAttributes.md +0 -18
  451. data/docs/UtmParamInfo.md +0 -20
  452. data/docs/V2TemplateRenderQueryAsSubResource.md +0 -18
  453. data/git_push.sh +0 -57
  454. data/lib/klaviyo-api-sdk/api/client_api.rb +0 -249
  455. data/lib/klaviyo-api-sdk/models/campaign_clone_query_as_sub_resource.rb +0 -272
  456. data/lib/klaviyo-api-sdk/models/campaign_create_query_as_sub_resource.rb +0 -272
  457. data/lib/klaviyo-api-sdk/models/campaign_message_assign_template_query_as_sub_resource.rb +0 -272
  458. data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_as_sub_resource.rb +0 -287
  459. data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_as_sub_resource.rb +0 -287
  460. data/lib/klaviyo-api-sdk/models/campaign_recipient_estimation_job_create_query_as_sub_resource.rb +0 -272
  461. data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_as_sub_resource.rb +0 -287
  462. data/lib/klaviyo-api-sdk/models/catalog_category_create_job_create_query_as_sub_resource.rb +0 -272
  463. data/lib/klaviyo-api-sdk/models/catalog_category_create_query_as_sub_resource.rb +0 -281
  464. data/lib/klaviyo-api-sdk/models/catalog_category_delete_job_create_query_as_sub_resource.rb +0 -272
  465. data/lib/klaviyo-api-sdk/models/catalog_category_delete_query_as_sub_resource.rb +0 -273
  466. data/lib/klaviyo-api-sdk/models/catalog_category_update_job_create_query_as_sub_resource.rb +0 -272
  467. data/lib/klaviyo-api-sdk/models/catalog_category_update_query_as_sub_resource.rb +0 -296
  468. data/lib/klaviyo-api-sdk/models/catalog_item_create_job_create_query_as_sub_resource.rb +0 -272
  469. data/lib/klaviyo-api-sdk/models/catalog_item_create_query_as_sub_resource.rb +0 -281
  470. data/lib/klaviyo-api-sdk/models/catalog_item_delete_job_create_query_as_sub_resource.rb +0 -272
  471. data/lib/klaviyo-api-sdk/models/catalog_item_update_job_create_query_as_sub_resource.rb +0 -272
  472. data/lib/klaviyo-api-sdk/models/catalog_item_update_query_as_sub_resource.rb +0 -296
  473. data/lib/klaviyo-api-sdk/models/catalog_job_error_payload.rb +0 -284
  474. data/lib/klaviyo-api-sdk/models/catalog_variant_create_job_create_query_as_sub_resource.rb +0 -272
  475. data/lib/klaviyo-api-sdk/models/catalog_variant_create_query_as_sub_resource.rb +0 -281
  476. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_job_create_query_as_sub_resource.rb +0 -272
  477. data/lib/klaviyo-api-sdk/models/catalog_variant_delete_query_as_sub_resource.rb +0 -273
  478. data/lib/klaviyo-api-sdk/models/catalog_variant_update_job_create_query_as_sub_resource.rb +0 -272
  479. data/lib/klaviyo-api-sdk/models/catalog_variant_update_query_as_sub_resource.rb +0 -287
  480. data/lib/klaviyo-api-sdk/models/data_privacy_create_deletion_job_query_as_sub_resource.rb +0 -272
  481. data/lib/klaviyo-api-sdk/models/email_message_content.rb +0 -266
  482. data/lib/klaviyo-api-sdk/models/email_tracking_options.rb +0 -268
  483. data/lib/klaviyo-api-sdk/models/error_source.rb +0 -227
  484. data/lib/klaviyo-api-sdk/models/flow_update_query_as_sub_resource.rb +0 -286
  485. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response.rb +0 -226
  486. data/lib/klaviyo-api-sdk/models/get_catalog_items4_xx_response_errors_inner.rb +0 -275
  487. data/lib/klaviyo-api-sdk/models/included_categories.rb +0 -301
  488. data/lib/klaviyo-api-sdk/models/included_categories_attributes.rb +0 -240
  489. data/lib/klaviyo-api-sdk/models/included_flow_action.rb +0 -300
  490. data/lib/klaviyo-api-sdk/models/included_flow_actions.rb +0 -300
  491. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes.rb +0 -282
  492. data/lib/klaviyo-api-sdk/models/included_flow_actions_attributes_tracking_options.rb +0 -105
  493. data/lib/klaviyo-api-sdk/models/included_flow_messages.rb +0 -300
  494. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes.rb +0 -270
  495. data/lib/klaviyo-api-sdk/models/included_flow_messages_attributes_content.rb +0 -105
  496. data/lib/klaviyo-api-sdk/models/included_flows.rb +0 -300
  497. data/lib/klaviyo-api-sdk/models/included_flows_attributes.rb +0 -264
  498. data/lib/klaviyo-api-sdk/models/included_items.rb +0 -301
  499. data/lib/klaviyo-api-sdk/models/included_items_attributes.rb +0 -332
  500. data/lib/klaviyo-api-sdk/models/included_lists.rb +0 -301
  501. data/lib/klaviyo-api-sdk/models/included_lists_attributes.rb +0 -240
  502. data/lib/klaviyo-api-sdk/models/included_metrics.rb +0 -301
  503. data/lib/klaviyo-api-sdk/models/included_metrics_attributes.rb +0 -250
  504. data/lib/klaviyo-api-sdk/models/included_profiles.rb +0 -301
  505. data/lib/klaviyo-api-sdk/models/included_segments.rb +0 -300
  506. data/lib/klaviyo-api-sdk/models/included_segments_attributes.rb +0 -240
  507. data/lib/klaviyo-api-sdk/models/included_tags.rb +0 -301
  508. data/lib/klaviyo-api-sdk/models/included_variants.rb +0 -301
  509. data/lib/klaviyo-api-sdk/models/included_variants_attributes.rb +0 -396
  510. data/lib/klaviyo-api-sdk/models/included_variants_links.rb +0 -224
  511. data/lib/klaviyo-api-sdk/models/list_partial_update_query_as_sub_resource.rb +0 -287
  512. data/lib/klaviyo-api-sdk/models/metric_aggregate_query_as_sub_resource.rb +0 -272
  513. data/lib/klaviyo-api-sdk/models/metric_aggregate_row_dto.rb +0 -242
  514. data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_as_sub_resource.rb +0 -281
  515. data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +0 -224
  516. data/lib/klaviyo-api-sdk/models/onsite_profile_meta_identifiers.rb +0 -269
  517. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource.rb +0 -272
  518. data/lib/klaviyo-api-sdk/models/onsite_subscription_create_query_as_sub_resource_attributes.rb +0 -265
  519. data/lib/klaviyo-api-sdk/models/profile_create_query_as_sub_resource.rb +0 -272
  520. data/lib/klaviyo-api-sdk/models/profile_partial_update_query_as_sub_resource.rb +0 -287
  521. data/lib/klaviyo-api-sdk/models/segment_partial_update_query_as_sub_resource.rb +0 -286
  522. data/lib/klaviyo-api-sdk/models/send_options.rb +0 -238
  523. data/lib/klaviyo-api-sdk/models/send_time_sub_object.rb +0 -240
  524. data/lib/klaviyo-api-sdk/models/sms_render_options.rb +0 -266
  525. data/lib/klaviyo-api-sdk/models/sms_tracking_options.rb +0 -240
  526. data/lib/klaviyo-api-sdk/models/subscription_create_job_create_query_as_sub_resource.rb +0 -272
  527. data/lib/klaviyo-api-sdk/models/suppression_create_job_create_query_as_sub_resource.rb +0 -272
  528. data/lib/klaviyo-api-sdk/models/tag_group_create_query_as_sub_resource.rb +0 -272
  529. data/lib/klaviyo-api-sdk/models/tag_group_update_query_as_sub_resource.rb +0 -287
  530. data/lib/klaviyo-api-sdk/models/tag_update_query_as_sub_resource.rb +0 -287
  531. data/lib/klaviyo-api-sdk/models/template_clone_query_as_sub_resource.rb +0 -272
  532. data/lib/klaviyo-api-sdk/models/template_create_query_as_sub_resource.rb +0 -272
  533. data/lib/klaviyo-api-sdk/models/template_render_query_as_sub_resource.rb +0 -272
  534. data/lib/klaviyo-api-sdk/models/template_update_query_as_sub_resource.rb +0 -287
  535. data/lib/klaviyo-api-sdk/models/unsubscription_create_job_create_query_as_sub_resource.rb +0 -272
  536. data/lib/klaviyo-api-sdk/models/unsuppression_create_job_create_query_as_sub_resource.rb +0 -272
  537. data/spec/api/campaigns_api_spec.rb +0 -284
  538. data/spec/api/catalogs_api_spec.rb +0 -759
  539. data/spec/api/client_api_spec.rb +0 -74
  540. data/spec/api/data_privacy_api_spec.rb +0 -47
  541. data/spec/api/events_api_spec.rb +0 -120
  542. data/spec/api/flows_api_spec.rb +0 -220
  543. data/spec/api/lists_api_spec.rb +0 -169
  544. data/spec/api/metrics_api_spec.rb +0 -74
  545. data/spec/api/profiles_api_spec.rb +0 -178
  546. data/spec/api/segments_api_spec.rb +0 -117
  547. data/spec/api/tags_api_spec.rb +0 -245
  548. data/spec/api/templates_api_spec.rb +0 -126
  549. data/spec/api_client_spec.rb +0 -226
  550. data/spec/configuration_spec.rb +0 -42
  551. data/spec/models/audiences_sub_object_spec.rb +0 -40
  552. data/spec/models/campaign_clone_query_as_sub_resource_attributes_spec.rb +0 -40
  553. data/spec/models/campaign_clone_query_as_sub_resource_spec.rb +0 -44
  554. data/spec/models/campaign_clone_query_spec.rb +0 -34
  555. data/spec/models/campaign_create_query_as_sub_resource_attributes_spec.rb +0 -64
  556. data/spec/models/campaign_create_query_as_sub_resource_spec.rb +0 -44
  557. data/spec/models/campaign_create_query_spec.rb +0 -34
  558. data/spec/models/campaign_message_assign_template_query_as_sub_resource_attributes_spec.rb +0 -40
  559. data/spec/models/campaign_message_assign_template_query_as_sub_resource_spec.rb +0 -44
  560. data/spec/models/campaign_message_assign_template_query_spec.rb +0 -34
  561. data/spec/models/campaign_message_partial_update_query_as_sub_resource_attributes_spec.rb +0 -40
  562. data/spec/models/campaign_message_partial_update_query_as_sub_resource_spec.rb +0 -50
  563. data/spec/models/campaign_message_partial_update_query_spec.rb +0 -34
  564. data/spec/models/campaign_partial_update_query_as_sub_resource_attributes_spec.rb +0 -58
  565. data/spec/models/campaign_partial_update_query_as_sub_resource_spec.rb +0 -50
  566. data/spec/models/campaign_partial_update_query_spec.rb +0 -34
  567. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  568. data/spec/models/campaign_recipient_estimation_job_create_query_as_sub_resource_spec.rb +0 -44
  569. data/spec/models/campaign_recipient_estimation_job_create_query_spec.rb +0 -34
  570. data/spec/models/campaign_send_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  571. data/spec/models/campaign_send_job_create_query_as_sub_resource_spec.rb +0 -44
  572. data/spec/models/campaign_send_job_create_query_spec.rb +0 -34
  573. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
  574. data/spec/models/campaign_send_job_partial_update_query_as_sub_resource_spec.rb +0 -50
  575. data/spec/models/campaign_send_job_partial_update_query_spec.rb +0 -34
  576. data/spec/models/campaign_tag_op_data_inner_spec.rb +0 -44
  577. data/spec/models/campaign_tag_op_spec.rb +0 -34
  578. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  579. data/spec/models/catalog_category_create_job_create_query_as_sub_resource_spec.rb +0 -44
  580. data/spec/models/catalog_category_create_job_create_query_spec.rb +0 -34
  581. data/spec/models/catalog_category_create_query_as_sub_resource_attributes_spec.rb +0 -56
  582. data/spec/models/catalog_category_create_query_as_sub_resource_spec.rb +0 -50
  583. data/spec/models/catalog_category_create_query_spec.rb +0 -34
  584. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  585. data/spec/models/catalog_category_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  586. data/spec/models/catalog_category_delete_job_create_query_spec.rb +0 -34
  587. data/spec/models/catalog_category_delete_query_as_sub_resource_spec.rb +0 -44
  588. data/spec/models/catalog_category_item_op_spec.rb +0 -34
  589. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  590. data/spec/models/catalog_category_update_job_create_query_as_sub_resource_spec.rb +0 -44
  591. data/spec/models/catalog_category_update_job_create_query_spec.rb +0 -34
  592. data/spec/models/catalog_category_update_query_as_sub_resource_attributes_spec.rb +0 -34
  593. data/spec/models/catalog_category_update_query_as_sub_resource_spec.rb +0 -56
  594. data/spec/models/catalog_category_update_query_spec.rb +0 -34
  595. data/spec/models/catalog_item_category_op_spec.rb +0 -34
  596. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  597. data/spec/models/catalog_item_create_job_create_query_as_sub_resource_spec.rb +0 -44
  598. data/spec/models/catalog_item_create_job_create_query_spec.rb +0 -34
  599. data/spec/models/catalog_item_create_query_as_sub_resource_attributes_spec.rb +0 -98
  600. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_data_inner_spec.rb +0 -44
  601. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_categories_spec.rb +0 -34
  602. data/spec/models/catalog_item_create_query_as_sub_resource_relationships_spec.rb +0 -34
  603. data/spec/models/catalog_item_create_query_as_sub_resource_spec.rb +0 -50
  604. data/spec/models/catalog_item_create_query_spec.rb +0 -34
  605. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  606. data/spec/models/catalog_item_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  607. data/spec/models/catalog_item_delete_job_create_query_spec.rb +0 -34
  608. data/spec/models/catalog_item_delete_query_as_sub_resource_spec.rb +0 -44
  609. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  610. data/spec/models/catalog_item_update_job_create_query_as_sub_resource_spec.rb +0 -44
  611. data/spec/models/catalog_item_update_job_create_query_spec.rb +0 -34
  612. data/spec/models/catalog_item_update_query_as_sub_resource_attributes_spec.rb +0 -76
  613. data/spec/models/catalog_item_update_query_as_sub_resource_spec.rb +0 -56
  614. data/spec/models/catalog_item_update_query_spec.rb +0 -34
  615. data/spec/models/catalog_job_error_payload_spec.rb +0 -58
  616. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  617. data/spec/models/catalog_variant_create_job_create_query_as_sub_resource_spec.rb +0 -44
  618. data/spec/models/catalog_variant_create_job_create_query_spec.rb +0 -34
  619. data/spec/models/catalog_variant_create_query_as_sub_resource_attributes_spec.rb +0 -126
  620. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_data_inner_spec.rb +0 -44
  621. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_items_spec.rb +0 -34
  622. data/spec/models/catalog_variant_create_query_as_sub_resource_relationships_spec.rb +0 -34
  623. data/spec/models/catalog_variant_create_query_as_sub_resource_spec.rb +0 -50
  624. data/spec/models/catalog_variant_create_query_spec.rb +0 -34
  625. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  626. data/spec/models/catalog_variant_delete_job_create_query_as_sub_resource_spec.rb +0 -44
  627. data/spec/models/catalog_variant_delete_job_create_query_spec.rb +0 -34
  628. data/spec/models/catalog_variant_delete_query_as_sub_resource_spec.rb +0 -44
  629. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  630. data/spec/models/catalog_variant_update_job_create_query_as_sub_resource_spec.rb +0 -44
  631. data/spec/models/catalog_variant_update_job_create_query_spec.rb +0 -34
  632. data/spec/models/catalog_variant_update_query_as_sub_resource_attributes_spec.rb +0 -98
  633. data/spec/models/catalog_variant_update_query_as_sub_resource_spec.rb +0 -50
  634. data/spec/models/catalog_variant_update_query_spec.rb +0 -34
  635. data/spec/models/content_sub_object_spec.rb +0 -64
  636. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_attributes_spec.rb +0 -46
  637. data/spec/models/data_privacy_create_deletion_job_query_as_sub_resource_spec.rb +0 -44
  638. data/spec/models/data_privacy_create_deletion_job_query_spec.rb +0 -34
  639. data/spec/models/email_message_content_spec.rb +0 -52
  640. data/spec/models/email_tracking_options_spec.rb +0 -52
  641. data/spec/models/error_source_spec.rb +0 -34
  642. data/spec/models/event_create_query_as_sub_resource_attributes_spec.rb +0 -64
  643. data/spec/models/event_create_query_as_sub_resource_spec.rb +0 -44
  644. data/spec/models/event_create_query_spec.rb +0 -34
  645. data/spec/models/flow_update_query_as_sub_resource_attributes_spec.rb +0 -34
  646. data/spec/models/flow_update_query_as_sub_resource_spec.rb +0 -50
  647. data/spec/models/flow_update_query_spec.rb +0 -34
  648. data/spec/models/get_campaigns4_xx_response_errors_inner_source_spec.rb +0 -40
  649. data/spec/models/get_campaigns4_xx_response_errors_inner_spec.rb +0 -58
  650. data/spec/models/get_campaigns4_xx_response_spec.rb +0 -34
  651. data/spec/models/get_catalog_items4_xx_response_errors_inner_source_spec.rb +0 -40
  652. data/spec/models/get_catalog_items4_xx_response_errors_inner_spec.rb +0 -58
  653. data/spec/models/get_catalog_items4_xx_response_spec.rb +0 -34
  654. data/spec/models/included_categories_attributes_spec.rb +0 -46
  655. data/spec/models/included_categories_spec.rb +0 -56
  656. data/spec/models/included_flow_action_spec.rb +0 -56
  657. data/spec/models/included_flow_actions_attributes_spec.rb +0 -76
  658. data/spec/models/included_flow_actions_attributes_tracking_options_spec.rb +0 -31
  659. data/spec/models/included_flow_actions_spec.rb +0 -56
  660. data/spec/models/included_flow_messages_attributes_content_spec.rb +0 -31
  661. data/spec/models/included_flow_messages_attributes_spec.rb +0 -58
  662. data/spec/models/included_flow_messages_spec.rb +0 -56
  663. data/spec/models/included_flows_attributes_spec.rb +0 -64
  664. data/spec/models/included_flows_spec.rb +0 -56
  665. data/spec/models/included_items_attributes_spec.rb +0 -94
  666. data/spec/models/included_items_spec.rb +0 -56
  667. data/spec/models/included_lists_attributes_spec.rb +0 -46
  668. data/spec/models/included_lists_spec.rb +0 -56
  669. data/spec/models/included_metrics_attributes_spec.rb +0 -52
  670. data/spec/models/included_metrics_spec.rb +0 -56
  671. data/spec/models/included_profiles_attributes_spec.rb +0 -112
  672. data/spec/models/included_profiles_spec.rb +0 -56
  673. data/spec/models/included_segments_attributes_spec.rb +0 -46
  674. data/spec/models/included_segments_spec.rb +0 -56
  675. data/spec/models/included_tags_spec.rb +0 -56
  676. data/spec/models/included_variants_attributes_spec.rb +0 -122
  677. data/spec/models/included_variants_links_spec.rb +0 -34
  678. data/spec/models/included_variants_spec.rb +0 -56
  679. data/spec/models/list_create_query_as_sub_resource_attributes_spec.rb +0 -34
  680. data/spec/models/list_create_query_as_sub_resource_spec.rb +0 -44
  681. data/spec/models/list_create_query_spec.rb +0 -34
  682. data/spec/models/list_members_add_query_data_inner_spec.rb +0 -44
  683. data/spec/models/list_members_add_query_spec.rb +0 -34
  684. data/spec/models/list_members_delete_query_spec.rb +0 -34
  685. data/spec/models/list_partial_update_query_as_sub_resource_spec.rb +0 -50
  686. data/spec/models/list_partial_update_query_spec.rb +0 -34
  687. data/spec/models/metric_aggregate_query_as_sub_resource_attributes_spec.rb +0 -104
  688. data/spec/models/metric_aggregate_query_as_sub_resource_spec.rb +0 -44
  689. data/spec/models/metric_aggregate_query_spec.rb +0 -34
  690. data/spec/models/metric_aggregate_row_dto_spec.rb +0 -40
  691. data/spec/models/metric_create_query_spec.rb +0 -40
  692. data/spec/models/onsite_profile_create_query_as_sub_resource_spec.rb +0 -50
  693. data/spec/models/onsite_profile_create_query_spec.rb +0 -34
  694. data/spec/models/onsite_profile_meta_identifiers_spec.rb +0 -64
  695. data/spec/models/onsite_profile_meta_spec.rb +0 -34
  696. data/spec/models/onsite_subscription_create_query_as_sub_resource_attributes_spec.rb +0 -58
  697. data/spec/models/onsite_subscription_create_query_as_sub_resource_spec.rb +0 -44
  698. data/spec/models/onsite_subscription_create_query_spec.rb +0 -34
  699. data/spec/models/profile_create_query_as_sub_resource_attributes_spec.rb +0 -94
  700. data/spec/models/profile_create_query_as_sub_resource_spec.rb +0 -44
  701. data/spec/models/profile_create_query_spec.rb +0 -34
  702. data/spec/models/profile_location_latitude_spec.rb +0 -31
  703. data/spec/models/profile_location_longitude_spec.rb +0 -31
  704. data/spec/models/profile_location_spec.rb +0 -82
  705. data/spec/models/profile_partial_update_query_as_sub_resource_spec.rb +0 -50
  706. data/spec/models/profile_partial_update_query_spec.rb +0 -34
  707. data/spec/models/segment_partial_update_query_as_sub_resource_attributes_spec.rb +0 -34
  708. data/spec/models/segment_partial_update_query_as_sub_resource_spec.rb +0 -50
  709. data/spec/models/segment_partial_update_query_spec.rb +0 -34
  710. data/spec/models/send_options_spec.rb +0 -40
  711. data/spec/models/send_options_sub_object_spec.rb +0 -40
  712. data/spec/models/send_strategy_sub_object_spec.rb +0 -46
  713. data/spec/models/send_time_sub_object_spec.rb +0 -40
  714. data/spec/models/sms_message_content_spec.rb +0 -40
  715. data/spec/models/sms_render_options_spec.rb +0 -52
  716. data/spec/models/sms_tracking_options_spec.rb +0 -40
  717. data/spec/models/static_schedule_options_spec.rb +0 -46
  718. data/spec/models/sto_schedule_options_spec.rb +0 -34
  719. data/spec/models/subscription_channels_spec.rb +0 -48
  720. data/spec/models/subscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  721. data/spec/models/subscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  722. data/spec/models/subscription_create_job_create_query_spec.rb +0 -34
  723. data/spec/models/subscription_spec.rb +0 -40
  724. data/spec/models/suppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  725. data/spec/models/suppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  726. data/spec/models/suppression_create_job_create_query_spec.rb +0 -34
  727. data/spec/models/suppression_spec.rb +0 -34
  728. data/spec/models/tag_create_query_as_sub_resource_attributes_spec.rb +0 -40
  729. data/spec/models/tag_create_query_as_sub_resource_spec.rb +0 -44
  730. data/spec/models/tag_create_query_spec.rb +0 -34
  731. data/spec/models/tag_group_create_query_as_sub_resource_attributes_spec.rb +0 -40
  732. data/spec/models/tag_group_create_query_as_sub_resource_spec.rb +0 -44
  733. data/spec/models/tag_group_create_query_spec.rb +0 -34
  734. data/spec/models/tag_group_update_query_as_sub_resource_attributes_spec.rb +0 -40
  735. data/spec/models/tag_group_update_query_as_sub_resource_spec.rb +0 -50
  736. data/spec/models/tag_group_update_query_spec.rb +0 -34
  737. data/spec/models/tag_segment_op_data_inner_spec.rb +0 -44
  738. data/spec/models/tag_segment_op_spec.rb +0 -34
  739. data/spec/models/tag_update_query_as_sub_resource_attributes_spec.rb +0 -34
  740. data/spec/models/tag_update_query_as_sub_resource_spec.rb +0 -50
  741. data/spec/models/tag_update_query_spec.rb +0 -34
  742. data/spec/models/template_clone_query_as_sub_resource_attributes_spec.rb +0 -46
  743. data/spec/models/template_clone_query_as_sub_resource_spec.rb +0 -50
  744. data/spec/models/template_clone_query_spec.rb +0 -34
  745. data/spec/models/template_create_query_as_sub_resource_attributes_spec.rb +0 -58
  746. data/spec/models/template_create_query_as_sub_resource_spec.rb +0 -44
  747. data/spec/models/template_create_query_spec.rb +0 -34
  748. data/spec/models/template_render_query_as_sub_resource_attributes_spec.rb +0 -46
  749. data/spec/models/template_render_query_as_sub_resource_spec.rb +0 -44
  750. data/spec/models/template_render_query_spec.rb +0 -34
  751. data/spec/models/template_update_query_as_sub_resource_attributes_spec.rb +0 -52
  752. data/spec/models/template_update_query_as_sub_resource_spec.rb +0 -50
  753. data/spec/models/template_update_query_spec.rb +0 -34
  754. data/spec/models/throttled_schedule_options_spec.rb +0 -40
  755. data/spec/models/tracking_options_sub_object_spec.rb +0 -52
  756. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -46
  757. data/spec/models/unsubscription_create_job_create_query_as_sub_resource_spec.rb +0 -44
  758. data/spec/models/unsubscription_create_job_create_query_spec.rb +0 -34
  759. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_attributes_spec.rb +0 -34
  760. data/spec/models/unsuppression_create_job_create_query_as_sub_resource_spec.rb +0 -44
  761. data/spec/models/unsuppression_create_job_create_query_spec.rb +0 -34
  762. data/spec/models/utm_param_info_spec.rb +0 -40
  763. data/spec/models/utm_params_sub_object_spec.rb +0 -40
  764. data/spec/models/v2_template_render_query_as_sub_resource_spec.rb +0 -34
  765. data/spec/spec_helper.rb +0 -111
@@ -1,20 +0,0 @@
1
- # KlaviyoAPI::SMSMessageContent
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **body** | **String** | | |
8
- | **media** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'klaviyo-api-sdk'
14
-
15
- instance = KlaviyoAPI::SMSMessageContent.new(
16
- body: null,
17
- media: null
18
- )
19
- ```
20
-
@@ -1,24 +0,0 @@
1
- # KlaviyoAPI::SMSRenderOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **shorten_links** | **Boolean** | | |
8
- | **add_org_prefix** | **Boolean** | | |
9
- | **add_info_link** | **Boolean** | | |
10
- | **add_opt_out_language** | **Boolean** | | |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'klaviyo-api-sdk'
16
-
17
- instance = KlaviyoAPI::SMSRenderOptions.new(
18
- shorten_links: null,
19
- add_org_prefix: null,
20
- add_info_link: null,
21
- add_opt_out_language: null
22
- )
23
- ```
24
-
@@ -1,20 +0,0 @@
1
- # KlaviyoAPI::SMSTrackingOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **add_utm** | **Boolean** | | |
8
- | **utm_params** | [**Array<UtmParamInfo>**](UtmParamInfo.md) | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'klaviyo-api-sdk'
14
-
15
- instance = KlaviyoAPI::SMSTrackingOptions.new(
16
- add_utm: null,
17
- utm_params: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # KlaviyoAPI::STOScheduleOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **date** | **Date** | The day to send on | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'klaviyo-api-sdk'
13
-
14
- instance = KlaviyoAPI::STOScheduleOptions.new(
15
- date: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # KlaviyoAPI::SegmentPartialUpdateQuery
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **data** | [**SegmentPartialUpdateQueryAsSubResource**](SegmentPartialUpdateQueryAsSubResource.md) | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'klaviyo-api-sdk'
13
-
14
- instance = KlaviyoAPI::SegmentPartialUpdateQuery.new(
15
- data: null
16
- )
17
- ```
18
-
@@ -1,22 +0,0 @@
1
- # KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | | |
8
- | **id** | **String** | | |
9
- | **attributes** | [**SegmentPartialUpdateQueryAsSubResourceAttributes**](SegmentPartialUpdateQueryAsSubResourceAttributes.md) | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'klaviyo-api-sdk'
15
-
16
- instance = KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new(
17
- type: null,
18
- id: null,
19
- attributes: null
20
- )
21
- ```
22
-
@@ -1,18 +0,0 @@
1
- # KlaviyoAPI::SegmentPartialUpdateQueryAsSubResourceAttributes
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'klaviyo-api-sdk'
13
-
14
- instance = KlaviyoAPI::SegmentPartialUpdateQueryAsSubResourceAttributes.new(
15
- name: null
16
- )
17
- ```
18
-
data/docs/SegmentsApi.md DELETED
@@ -1,469 +0,0 @@
1
- # KlaviyoAPI::SegmentsApi
2
-
3
- All URIs are relative to *https://a.klaviyo.com*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_segment**](SegmentsApi.md#get_segment) | **GET** /api/segments/{id}/ | Get Segment |
8
- | [**get_segment_profiles**](SegmentsApi.md#get_segment_profiles) | **GET** /api/segments/{segment_id}/profiles/ | Get Segment Profiles |
9
- | [**get_segment_relationships**](SegmentsApi.md#get_segment_relationships) | **GET** /api/segments/{id}/relationships/{related_resource}/ | Get Segment Relationships |
10
- | [**get_segment_tags**](SegmentsApi.md#get_segment_tags) | **GET** /api/segments/{segment_id}/tags/ | Get Segment Tags |
11
- | [**get_segments**](SegmentsApi.md#get_segments) | **GET** /api/segments/ | Get Segments |
12
- | [**update_segment**](SegmentsApi.md#update_segment) | **PATCH** /api/segments/{id}/ | Update Segment |
13
-
14
-
15
- ## get_segment
16
-
17
- > Hash<String, Object> get_segment(id, opts)
18
-
19
- Get Segment
20
-
21
- Get a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
22
-
23
- ### Examples
24
-
25
- ```ruby
26
- require 'time'
27
- require 'klaviyo-api-sdk'
28
- # setup authorization
29
- KlaviyoAPI.configure do |config|
30
- # Configure API key authorization: Klaviyo-API-Key
31
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
32
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
34
- end
35
-
36
- api_instance = KlaviyoAPI::SegmentsApi.new
37
- id = 'id_example' # String |
38
- opts = {
39
- fields_segment: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
40
- }
41
-
42
- begin
43
- # Get Segment
44
- result = api_instance.get_segment(id, opts)
45
- p result
46
- rescue KlaviyoAPI::ApiError => e
47
- puts "Error when calling SegmentsApi->get_segment: #{e}"
48
- end
49
- ```
50
-
51
- #### Using the get_segment_with_http_info variant
52
-
53
- This returns an Array which contains the response data, status code and headers.
54
-
55
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_with_http_info(id, opts)
56
-
57
- ```ruby
58
- begin
59
- # Get Segment
60
- data, status_code, headers = api_instance.get_segment_with_http_info(id, opts)
61
- p status_code # => 2xx
62
- p headers # => { ... }
63
- p data # => Hash&lt;String, Object&gt;
64
- rescue KlaviyoAPI::ApiError => e
65
- puts "Error when calling SegmentsApi->get_segment_with_http_info: #{e}"
66
- end
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Name | Type | Description | Notes |
72
- | ---- | ---- | ----------- | ----- |
73
- | **id** | **String** | | |
74
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
75
-
76
- ### Return type
77
-
78
- **Hash&lt;String, Object&gt;**
79
-
80
- ### Authorization
81
-
82
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
83
-
84
- ### HTTP request headers
85
-
86
- - **Content-Type**: Not defined
87
- - **Accept**: application/json
88
-
89
-
90
- ## get_segment_profiles
91
-
92
- > Hash&lt;String, Object&gt; get_segment_profiles(segment_id, opts)
93
-
94
- Get Segment Profiles
95
-
96
- Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, and `push_token` fields. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
97
-
98
- ### Examples
99
-
100
- ```ruby
101
- require 'time'
102
- require 'klaviyo-api-sdk'
103
- # setup authorization
104
- KlaviyoAPI.configure do |config|
105
- # Configure API key authorization: Klaviyo-API-Key
106
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
107
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
108
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
109
- end
110
-
111
- api_instance = KlaviyoAPI::SegmentsApi.new
112
- segment_id = 'segment_id_example' # String |
113
- opts = {
114
- fields_profile: ['email'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
115
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals`
116
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
117
- }
118
-
119
- begin
120
- # Get Segment Profiles
121
- result = api_instance.get_segment_profiles(segment_id, opts)
122
- p result
123
- rescue KlaviyoAPI::ApiError => e
124
- puts "Error when calling SegmentsApi->get_segment_profiles: #{e}"
125
- end
126
- ```
127
-
128
- #### Using the get_segment_profiles_with_http_info variant
129
-
130
- This returns an Array which contains the response data, status code and headers.
131
-
132
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_profiles_with_http_info(segment_id, opts)
133
-
134
- ```ruby
135
- begin
136
- # Get Segment Profiles
137
- data, status_code, headers = api_instance.get_segment_profiles_with_http_info(segment_id, opts)
138
- p status_code # => 2xx
139
- p headers # => { ... }
140
- p data # => Hash&lt;String, Object&gt;
141
- rescue KlaviyoAPI::ApiError => e
142
- puts "Error when calling SegmentsApi->get_segment_profiles_with_http_info: #{e}"
143
- end
144
- ```
145
-
146
- ### Parameters
147
-
148
- | Name | Type | Description | Notes |
149
- | ---- | ---- | ----------- | ----- |
150
- | **segment_id** | **String** | | |
151
- | **fields_profile** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
152
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; | [optional] |
153
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
154
-
155
- ### Return type
156
-
157
- **Hash&lt;String, Object&gt;**
158
-
159
- ### Authorization
160
-
161
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
162
-
163
- ### HTTP request headers
164
-
165
- - **Content-Type**: Not defined
166
- - **Accept**: application/json
167
-
168
-
169
- ## get_segment_relationships
170
-
171
- > Hash&lt;String, Object&gt; get_segment_relationships(id, related_resource, opts)
172
-
173
- Get Segment Relationships
174
-
175
- Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID. You can adjust the number of results per page via the `page[size]` query parameter, e.g. `?page[size]=25`. **Default**: 20. **Max**: 100.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Profiles Read` `Segments Read`
176
-
177
- ### Examples
178
-
179
- ```ruby
180
- require 'time'
181
- require 'klaviyo-api-sdk'
182
- # setup authorization
183
- KlaviyoAPI.configure do |config|
184
- # Configure API key authorization: Klaviyo-API-Key
185
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
186
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
187
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
188
- end
189
-
190
- api_instance = KlaviyoAPI::SegmentsApi.new
191
- id = 'id_example' # String |
192
- related_resource = 'profiles' # String |
193
- opts = {
194
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
195
- }
196
-
197
- begin
198
- # Get Segment Relationships
199
- result = api_instance.get_segment_relationships(id, related_resource, opts)
200
- p result
201
- rescue KlaviyoAPI::ApiError => e
202
- puts "Error when calling SegmentsApi->get_segment_relationships: #{e}"
203
- end
204
- ```
205
-
206
- #### Using the get_segment_relationships_with_http_info variant
207
-
208
- This returns an Array which contains the response data, status code and headers.
209
-
210
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_relationships_with_http_info(id, related_resource, opts)
211
-
212
- ```ruby
213
- begin
214
- # Get Segment Relationships
215
- data, status_code, headers = api_instance.get_segment_relationships_with_http_info(id, related_resource, opts)
216
- p status_code # => 2xx
217
- p headers # => { ... }
218
- p data # => Hash&lt;String, Object&gt;
219
- rescue KlaviyoAPI::ApiError => e
220
- puts "Error when calling SegmentsApi->get_segment_relationships_with_http_info: #{e}"
221
- end
222
- ```
223
-
224
- ### Parameters
225
-
226
- | Name | Type | Description | Notes |
227
- | ---- | ---- | ----------- | ----- |
228
- | **id** | **String** | | |
229
- | **related_resource** | **String** | | |
230
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
231
-
232
- ### Return type
233
-
234
- **Hash&lt;String, Object&gt;**
235
-
236
- ### Authorization
237
-
238
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
239
-
240
- ### HTTP request headers
241
-
242
- - **Content-Type**: Not defined
243
- - **Accept**: application/json
244
-
245
-
246
- ## get_segment_tags
247
-
248
- > Hash&lt;String, Object&gt; get_segment_tags(segment_id, opts)
249
-
250
- Get Segment Tags
251
-
252
- Return all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `Segments Read` `Tags Read`
253
-
254
- ### Examples
255
-
256
- ```ruby
257
- require 'time'
258
- require 'klaviyo-api-sdk'
259
- # setup authorization
260
- KlaviyoAPI.configure do |config|
261
- # Configure API key authorization: Klaviyo-API-Key
262
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
263
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
264
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
265
- end
266
-
267
- api_instance = KlaviyoAPI::SegmentsApi.new
268
- segment_id = 'segment_id_example' # String |
269
- opts = {
270
- fields_tag: ['name'] # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
271
- }
272
-
273
- begin
274
- # Get Segment Tags
275
- result = api_instance.get_segment_tags(segment_id, opts)
276
- p result
277
- rescue KlaviyoAPI::ApiError => e
278
- puts "Error when calling SegmentsApi->get_segment_tags: #{e}"
279
- end
280
- ```
281
-
282
- #### Using the get_segment_tags_with_http_info variant
283
-
284
- This returns an Array which contains the response data, status code and headers.
285
-
286
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segment_tags_with_http_info(segment_id, opts)
287
-
288
- ```ruby
289
- begin
290
- # Get Segment Tags
291
- data, status_code, headers = api_instance.get_segment_tags_with_http_info(segment_id, opts)
292
- p status_code # => 2xx
293
- p headers # => { ... }
294
- p data # => Hash&lt;String, Object&gt;
295
- rescue KlaviyoAPI::ApiError => e
296
- puts "Error when calling SegmentsApi->get_segment_tags_with_http_info: #{e}"
297
- end
298
- ```
299
-
300
- ### Parameters
301
-
302
- | Name | Type | Description | Notes |
303
- | ---- | ---- | ----------- | ----- |
304
- | **segment_id** | **String** | | |
305
- | **fields_tag** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
306
-
307
- ### Return type
308
-
309
- **Hash&lt;String, Object&gt;**
310
-
311
- ### Authorization
312
-
313
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
314
-
315
- ### HTTP request headers
316
-
317
- - **Content-Type**: Not defined
318
- - **Accept**: application/json
319
-
320
-
321
- ## get_segments
322
-
323
- > Hash&lt;String, Object&gt; get_segments(opts)
324
-
325
- Get Segments
326
-
327
- Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields. Returns a maximum of 10 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Read`
328
-
329
- ### Examples
330
-
331
- ```ruby
332
- require 'time'
333
- require 'klaviyo-api-sdk'
334
- # setup authorization
335
- KlaviyoAPI.configure do |config|
336
- # Configure API key authorization: Klaviyo-API-Key
337
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
338
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
340
- end
341
-
342
- api_instance = KlaviyoAPI::SegmentsApi.new
343
- opts = {
344
- fields_segment: ['name'], # Array<String> | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
345
- filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`
346
- page_cursor: 'page_cursor_example' # String | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination
347
- }
348
-
349
- begin
350
- # Get Segments
351
- result = api_instance.get_segments(opts)
352
- p result
353
- rescue KlaviyoAPI::ApiError => e
354
- puts "Error when calling SegmentsApi->get_segments: #{e}"
355
- end
356
- ```
357
-
358
- #### Using the get_segments_with_http_info variant
359
-
360
- This returns an Array which contains the response data, status code and headers.
361
-
362
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_segments_with_http_info(opts)
363
-
364
- ```ruby
365
- begin
366
- # Get Segments
367
- data, status_code, headers = api_instance.get_segments_with_http_info(opts)
368
- p status_code # => 2xx
369
- p headers # => { ... }
370
- p data # => Hash&lt;String, Object&gt;
371
- rescue KlaviyoAPI::ApiError => e
372
- puts "Error when calling SegmentsApi->get_segments_with_http_info: #{e}"
373
- end
374
- ```
375
-
376
- ### Parameters
377
-
378
- | Name | Type | Description | Notes |
379
- | ---- | ---- | ----------- | ----- |
380
- | **fields_segment** | [**Array&lt;String&gt;**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets | [optional] |
381
- | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;name&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;id&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;created&#x60;: &#x60;greater-than&#x60;&lt;br&gt;&#x60;updated&#x60;: &#x60;greater-than&#x60; | [optional] |
382
- | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination | [optional] |
383
-
384
- ### Return type
385
-
386
- **Hash&lt;String, Object&gt;**
387
-
388
- ### Authorization
389
-
390
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
391
-
392
- ### HTTP request headers
393
-
394
- - **Content-Type**: Not defined
395
- - **Accept**: application/json
396
-
397
-
398
- ## update_segment
399
-
400
- > Hash&lt;String, Object&gt; update_segment(id, segment_partial_update_query)
401
-
402
- Update Segment
403
-
404
- Update the name of a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `Segments Write`
405
-
406
- ### Examples
407
-
408
- ```ruby
409
- require 'time'
410
- require 'klaviyo-api-sdk'
411
- # setup authorization
412
- KlaviyoAPI.configure do |config|
413
- # Configure API key authorization: Klaviyo-API-Key
414
- config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY'
415
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
416
- # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer'
417
- end
418
-
419
- api_instance = KlaviyoAPI::SegmentsApi.new
420
- id = 'id_example' # String |
421
- segment_partial_update_query = KlaviyoAPI::SegmentPartialUpdateQuery.new({data: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResource.new({type: 'segment', id: 'id_example', attributes: KlaviyoAPI::SegmentPartialUpdateQueryAsSubResourceAttributes.new({name: 'name_example'})})}) # SegmentPartialUpdateQuery |
422
-
423
- begin
424
- # Update Segment
425
- result = api_instance.update_segment(id, segment_partial_update_query)
426
- p result
427
- rescue KlaviyoAPI::ApiError => e
428
- puts "Error when calling SegmentsApi->update_segment: #{e}"
429
- end
430
- ```
431
-
432
- #### Using the update_segment_with_http_info variant
433
-
434
- This returns an Array which contains the response data, status code and headers.
435
-
436
- > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_segment_with_http_info(id, segment_partial_update_query)
437
-
438
- ```ruby
439
- begin
440
- # Update Segment
441
- data, status_code, headers = api_instance.update_segment_with_http_info(id, segment_partial_update_query)
442
- p status_code # => 2xx
443
- p headers # => { ... }
444
- p data # => Hash&lt;String, Object&gt;
445
- rescue KlaviyoAPI::ApiError => e
446
- puts "Error when calling SegmentsApi->update_segment_with_http_info: #{e}"
447
- end
448
- ```
449
-
450
- ### Parameters
451
-
452
- | Name | Type | Description | Notes |
453
- | ---- | ---- | ----------- | ----- |
454
- | **id** | **String** | | |
455
- | **segment_partial_update_query** | [**SegmentPartialUpdateQuery**](SegmentPartialUpdateQuery.md) | | |
456
-
457
- ### Return type
458
-
459
- **Hash&lt;String, Object&gt;**
460
-
461
- ### Authorization
462
-
463
- [Klaviyo-API-Key](../README.md#Klaviyo-API-Key)
464
-
465
- ### HTTP request headers
466
-
467
- - **Content-Type**: application/json
468
- - **Accept**: application/json
469
-
data/docs/SendOptions.md DELETED
@@ -1,20 +0,0 @@
1
- # KlaviyoAPI::SendOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **use_smart_sending** | **Boolean** | | |
8
- | **is_transactional** | **Boolean** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'klaviyo-api-sdk'
14
-
15
- instance = KlaviyoAPI::SendOptions.new(
16
- use_smart_sending: null,
17
- is_transactional: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # KlaviyoAPI::SendOptionsSubObject
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **use_smart_sending** | **Boolean** | Use smart sending. Defaults to True | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'klaviyo-api-sdk'
13
-
14
- instance = KlaviyoAPI::SendOptionsSubObject.new(
15
- use_smart_sending: null
16
- )
17
- ```
18
-
@@ -1,24 +0,0 @@
1
- # KlaviyoAPI::SendStrategySubObject
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **method** | **String** | Describes the shape of the options object. Allowed values: [&#39;static&#39;, &#39;throttled&#39;, &#39;immediate&#39;, &#39;smart_send_time&#39;] | |
8
- | **options_static** | [**StaticScheduleOptions**](StaticScheduleOptions.md) | | [optional] |
9
- | **options_throttled** | [**ThrottledScheduleOptions**](ThrottledScheduleOptions.md) | | [optional] |
10
- | **options_sto** | [**STOScheduleOptions**](STOScheduleOptions.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'klaviyo-api-sdk'
16
-
17
- instance = KlaviyoAPI::SendStrategySubObject.new(
18
- method: static,
19
- options_static: null,
20
- options_throttled: null,
21
- options_sto: null
22
- )
23
- ```
24
-