klaviyo_sdk 1.0.0.20220329 → 1.0.1.20220329

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.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +10 -0
  3. data/README.md +3 -3
  4. data/Rakefile +10 -0
  5. data/docs/Campaign.md +38 -0
  6. data/docs/CampaignsApi.md +707 -0
  7. data/docs/CheckMembershipRequest.md +22 -0
  8. data/docs/DataPrivacyApi.md +81 -0
  9. data/docs/DeleteEmail.md +18 -0
  10. data/docs/DeletePerson.md +18 -0
  11. data/docs/DeletePhone.md +18 -0
  12. data/docs/DeprecatedGetListResponse.md +30 -0
  13. data/docs/DeprecatedGetListResponseData.md +28 -0
  14. data/docs/GlobalExclusionResponseData.md +30 -0
  15. data/docs/IdentifyPayload.md +20 -0
  16. data/docs/IdentifyPayloadProperties.md +42 -0
  17. data/docs/InlineObject.md +18 -0
  18. data/docs/InlineObject3.md +18 -0
  19. data/docs/InlineObject4.md +18 -0
  20. data/docs/InlineObject5.md +22 -0
  21. data/docs/ListsSegmentsApi.md +1198 -0
  22. data/docs/Metric.md +28 -0
  23. data/docs/MetricExport.md +32 -0
  24. data/docs/MetricTimeline.md +24 -0
  25. data/docs/MetricTimelineData.md +34 -0
  26. data/docs/MetricsApi.md +329 -0
  27. data/docs/Person.md +56 -0
  28. data/docs/PrivacyEmail.md +18 -0
  29. data/docs/PrivacyId.md +18 -0
  30. data/docs/PrivacyPhone.md +18 -0
  31. data/docs/ProfilesApi.md +391 -0
  32. data/docs/RenderedTemplate.md +24 -0
  33. data/docs/Template.md +30 -0
  34. data/docs/TemplatesApi.md +541 -0
  35. data/docs/TrackIdentifyApi.md +267 -0
  36. data/docs/TrackPayload.md +24 -0
  37. data/docs/TrackPayloadCustomerProperties.md +20 -0
  38. data/docs/TrackPayloadProperties.md +22 -0
  39. data/git_push.sh +57 -0
  40. data/klaviyo_sdk-1.0.0.20220329.gem +0 -0
  41. data/klaviyo_sdk.gemspec +6 -1
  42. data/lib/klaviyo_sdk/api_client.rb +1 -1
  43. data/spec/api/campaigns_api_spec.rb +165 -0
  44. data/spec/api/data_privacy_api_spec.rb +47 -0
  45. data/spec/api/lists_segments_api_spec.rb +239 -0
  46. data/spec/api/metrics_api_spec.rb +96 -0
  47. data/spec/api/profiles_api_spec.rb +103 -0
  48. data/spec/api/templates_api_spec.rb +130 -0
  49. data/spec/api/track_identify_api_spec.rb +83 -0
  50. data/spec/api_client_spec.rb +226 -0
  51. data/spec/configuration_spec.rb +42 -0
  52. data/spec/models/campaign_spec.rb +94 -0
  53. data/spec/models/check_membership_request_spec.rb +46 -0
  54. data/spec/models/delete_email_spec.rb +34 -0
  55. data/spec/models/delete_person_spec.rb +34 -0
  56. data/spec/models/delete_phone_spec.rb +34 -0
  57. data/spec/models/deprecated_get_list_response_data_spec.rb +64 -0
  58. data/spec/models/deprecated_get_list_response_spec.rb +70 -0
  59. data/spec/models/global_exclusion_response_data_spec.rb +70 -0
  60. data/spec/models/identify_payload_properties_spec.rb +106 -0
  61. data/spec/models/identify_payload_spec.rb +40 -0
  62. data/spec/models/inline_object3_spec.rb +34 -0
  63. data/spec/models/inline_object4_spec.rb +34 -0
  64. data/spec/models/inline_object5_spec.rb +46 -0
  65. data/spec/models/inline_object_spec.rb +34 -0
  66. data/spec/models/metric_export_spec.rb +76 -0
  67. data/spec/models/metric_spec.rb +64 -0
  68. data/spec/models/metric_timeline_data_spec.rb +82 -0
  69. data/spec/models/metric_timeline_spec.rb +52 -0
  70. data/spec/models/person_spec.rb +148 -0
  71. data/spec/models/privacy_email_spec.rb +34 -0
  72. data/spec/models/privacy_id_spec.rb +34 -0
  73. data/spec/models/privacy_phone_spec.rb +34 -0
  74. data/spec/models/rendered_template_spec.rb +52 -0
  75. data/spec/models/template_spec.rb +70 -0
  76. data/spec/models/track_payload_customer_properties_spec.rb +40 -0
  77. data/spec/models/track_payload_properties_spec.rb +46 -0
  78. data/spec/models/track_payload_spec.rb +52 -0
  79. data/spec/spec_helper.rb +111 -0
  80. metadata +79 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6a9b4c3dbfe3753beb6c0590256bb9d35af5ef6b0eb3e7813b9ae1d5d043389f
4
- data.tar.gz: 6af9bccecb70f90298dbed051bb8f96f9e55358f421a5e2b3a8a8f62ee40cf3a
3
+ metadata.gz: 2c3244985fe392ef6c86a0f1c19e8c31ff01cd7719fae777df56ecae5b5e2982
4
+ data.tar.gz: a2c33d939b37020fbf7176346dea1b9b83a048127ecd7f493a886dc96eb8eaae
5
5
  SHA512:
6
- metadata.gz: fa0092e2dc0e4509a501421671ef94a394b6cfa0e30398a79ed0484bc5735f67034b86024f245c3fb53e6fe6da810bb3522c05882942d88ac0f587bcf54c8b08
7
- data.tar.gz: 669c8ff8a615389882c65928122237dc7791e59fbd6697d9bacb9032d895eeea47c24f5ddf5f78e71fcc169671a73c3b4c4c19259ce9ae0cafe46edf4e2932f8
6
+ metadata.gz: 59ef6b3b6464f666dab7d7d934ce7b0905e6a2cba06bb8d8aaf2ad1291214d747a6b2c978f1fb5e31904e3da5c7422963fe9d49a2425599aa918ecbf8c341401
7
+ data.tar.gz: 8c743a3d049543a3d9bf0d2bf2bd709b0c4fff9746cdc403a0556d3c10d5cddbc83647dd3e65a3e636d266cf7971c0c7180e230f81b2db0dabc3d5c74361a429
data/Gemfile ADDED
@@ -0,0 +1,10 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 13.0.1'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ gem 'retriable', '~> 3.1'
10
+ end
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Klaviyo Ruby SDK
2
2
 
3
- - SDK version: 1.0.0.20220329
3
+ - SDK version: 1.0.1.20220329
4
4
 
5
5
  ## Helpful Resources
6
6
 
@@ -60,13 +60,13 @@ gem build klaviyo_sdk.gemspec
60
60
  Then install the gem locally:
61
61
 
62
62
  ```shell
63
- gem install ./klaviyo_sdk-1.0.0.20220329.gem
63
+ gem install ./klaviyo_sdk-1.0.1.20220329.gem
64
64
  ```
65
65
 
66
66
 
67
67
  Finally add this to the Gemfile:
68
68
 
69
- gem 'klaviyo_sdk', '~> 1.0.0.20220329'
69
+ gem 'klaviyo_sdk', '~> 1.0.1.20220329'
70
70
 
71
71
  To install directly from rubygems:
72
72
 
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
data/docs/Campaign.md ADDED
@@ -0,0 +1,38 @@
1
+ # Client::Campaign
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | | [optional] |
8
+ | **id** | **String** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **subject** | **String** | | [optional] |
11
+ | **from_email** | **String** | | [optional] |
12
+ | **from_name** | **String** | | [optional] |
13
+ | **list_id** | **String** | | [optional] |
14
+ | **template** | **Hash<String, Object>** | | [optional] |
15
+ | **status** | **String** | | [optional] |
16
+ | **sent_at** | **String** | | [optional] |
17
+ | **created** | **String** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'klaviyo_sdk'
23
+
24
+ instance = Client::Campaign.new(
25
+ object: campaign,
26
+ id: CAMPAIGN_ID,
27
+ name: Campaign Name,
28
+ subject: Company Monthly Newsletter,
29
+ from_email: george.washington@klaviyo.com,
30
+ from_name: George Washington,
31
+ list_id: erRoOX,
32
+ template: null,
33
+ status: draft,
34
+ sent_at: 2020-12-02 18:45:04,
35
+ created: 2020-12-01 18:45:04
36
+ )
37
+ ```
38
+