klaviyo_sdk 1.0.3.20220329 → 1.0.4.20220329

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +25 -3
  4. data/klaviyo_sdk.gemspec +1 -1
  5. data/lib/klaviyo_sdk/api/data_privacy_api.rb +2 -2
  6. data/lib/klaviyo_sdk/api/profiles_api.rb +66 -0
  7. data/lib/klaviyo_sdk/api_client.rb +1 -1
  8. data/lib/klaviyo_sdk/models/campaign.rb +198 -18
  9. data/lib/klaviyo_sdk/models/campaign_lists.rb +318 -0
  10. data/lib/klaviyo_sdk/models/campaigns.rb +487 -0
  11. data/lib/klaviyo_sdk/models/inline_object5.rb +0 -1
  12. data/lib/klaviyo_sdk/models/inline_response200.rb +218 -0
  13. data/lib/klaviyo_sdk.rb +3 -0
  14. metadata +6 -76
  15. data/docs/Campaign.md +0 -38
  16. data/docs/CampaignsApi.md +0 -707
  17. data/docs/CheckMembershipRequest.md +0 -22
  18. data/docs/DataPrivacyApi.md +0 -81
  19. data/docs/DeleteEmail.md +0 -18
  20. data/docs/DeletePerson.md +0 -18
  21. data/docs/DeletePhone.md +0 -18
  22. data/docs/DeprecatedGetListResponse.md +0 -30
  23. data/docs/DeprecatedGetListResponseData.md +0 -28
  24. data/docs/GlobalExclusionResponseData.md +0 -30
  25. data/docs/IdentifyPayload.md +0 -20
  26. data/docs/IdentifyPayloadProperties.md +0 -42
  27. data/docs/InlineObject.md +0 -18
  28. data/docs/InlineObject3.md +0 -18
  29. data/docs/InlineObject4.md +0 -18
  30. data/docs/InlineObject5.md +0 -22
  31. data/docs/ListsSegmentsApi.md +0 -1198
  32. data/docs/Metric.md +0 -28
  33. data/docs/MetricExport.md +0 -32
  34. data/docs/MetricTimeline.md +0 -24
  35. data/docs/MetricTimelineData.md +0 -34
  36. data/docs/MetricsApi.md +0 -329
  37. data/docs/Person.md +0 -56
  38. data/docs/PrivacyEmail.md +0 -18
  39. data/docs/PrivacyId.md +0 -18
  40. data/docs/PrivacyPhone.md +0 -18
  41. data/docs/ProfilesApi.md +0 -391
  42. data/docs/RenderedTemplate.md +0 -24
  43. data/docs/Template.md +0 -30
  44. data/docs/TemplatesApi.md +0 -541
  45. data/docs/TrackIdentifyApi.md +0 -267
  46. data/docs/TrackPayload.md +0 -24
  47. data/docs/TrackPayloadCustomerProperties.md +0 -20
  48. data/docs/TrackPayloadProperties.md +0 -22
  49. data/git_push.sh +0 -57
  50. data/klaviyo_sdk-1.0.3.2022.03.29.gem +0 -0
  51. data/spec/api/campaigns_api_spec.rb +0 -165
  52. data/spec/api/data_privacy_api_spec.rb +0 -47
  53. data/spec/api/lists_segments_api_spec.rb +0 -239
  54. data/spec/api/metrics_api_spec.rb +0 -96
  55. data/spec/api/profiles_api_spec.rb +0 -103
  56. data/spec/api/templates_api_spec.rb +0 -130
  57. data/spec/api/track_identify_api_spec.rb +0 -83
  58. data/spec/api_client_spec.rb +0 -226
  59. data/spec/configuration_spec.rb +0 -42
  60. data/spec/models/campaign_spec.rb +0 -94
  61. data/spec/models/check_membership_request_spec.rb +0 -46
  62. data/spec/models/delete_email_spec.rb +0 -34
  63. data/spec/models/delete_person_spec.rb +0 -34
  64. data/spec/models/delete_phone_spec.rb +0 -34
  65. data/spec/models/deprecated_get_list_response_data_spec.rb +0 -64
  66. data/spec/models/deprecated_get_list_response_spec.rb +0 -70
  67. data/spec/models/global_exclusion_response_data_spec.rb +0 -70
  68. data/spec/models/identify_payload_properties_spec.rb +0 -106
  69. data/spec/models/identify_payload_spec.rb +0 -40
  70. data/spec/models/inline_object3_spec.rb +0 -34
  71. data/spec/models/inline_object4_spec.rb +0 -34
  72. data/spec/models/inline_object5_spec.rb +0 -46
  73. data/spec/models/inline_object_spec.rb +0 -34
  74. data/spec/models/metric_export_spec.rb +0 -76
  75. data/spec/models/metric_spec.rb +0 -64
  76. data/spec/models/metric_timeline_data_spec.rb +0 -82
  77. data/spec/models/metric_timeline_spec.rb +0 -52
  78. data/spec/models/person_spec.rb +0 -148
  79. data/spec/models/privacy_email_spec.rb +0 -34
  80. data/spec/models/privacy_id_spec.rb +0 -34
  81. data/spec/models/privacy_phone_spec.rb +0 -34
  82. data/spec/models/rendered_template_spec.rb +0 -52
  83. data/spec/models/template_spec.rb +0 -70
  84. data/spec/models/track_payload_customer_properties_spec.rb +0 -40
  85. data/spec/models/track_payload_properties_spec.rb +0 -46
  86. data/spec/models/track_payload_spec.rb +0 -52
  87. data/spec/spec_helper.rb +0 -111
@@ -0,0 +1,218 @@
1
+ =begin
2
+ #Klaviyo API
3
+
4
+ #Empowering creators to own their destiny
5
+
6
+ The version of the OpenAPI document: 2022.03.29
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Klaviyo
17
+ class InlineResponse200
18
+ attr_accessor :id
19
+
20
+ # Attribute mapping from ruby-style variable name to JSON key.
21
+ def self.attribute_map
22
+ {
23
+ :'id' => :'id'
24
+ }
25
+ end
26
+
27
+ # Returns all the JSON keys this model knows about
28
+ def self.acceptable_attributes
29
+ attribute_map.values
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.openapi_types
34
+ {
35
+ :'id' => :'String'
36
+ }
37
+ end
38
+
39
+ # List of attributes with nullable: true
40
+ def self.openapi_nullable
41
+ Set.new([
42
+ ])
43
+ end
44
+
45
+ # Initializes the object
46
+ # @param [Hash] attributes Model attributes in the form of hash
47
+ def initialize(attributes = {})
48
+ if (!attributes.is_a?(Hash))
49
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::InlineResponse200` initialize method"
50
+ end
51
+
52
+ # check to see if the attribute exists and convert string to symbol for hash key
53
+ attributes = attributes.each_with_object({}) { |(k, v), h|
54
+ if (!self.class.attribute_map.key?(k.to_sym))
55
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::InlineResponse200`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
+ end
57
+ h[k.to_sym] = v
58
+ }
59
+
60
+ if attributes.key?(:'id')
61
+ self.id = attributes[:'id']
62
+ end
63
+ end
64
+
65
+ # Show invalid properties with the reasons. Usually used together with valid?
66
+ # @return Array for valid properties with the reasons
67
+ def list_invalid_properties
68
+ invalid_properties = Array.new
69
+ invalid_properties
70
+ end
71
+
72
+ # Check to see if the all the properties in the model are valid
73
+ # @return true if the model is valid
74
+ def valid?
75
+ true
76
+ end
77
+
78
+ # Checks equality by comparing each attribute.
79
+ # @param [Object] Object to be compared
80
+ def ==(o)
81
+ return true if self.equal?(o)
82
+ self.class == o.class &&
83
+ id == o.id
84
+ end
85
+
86
+ # @see the `==` method
87
+ # @param [Object] Object to be compared
88
+ def eql?(o)
89
+ self == o
90
+ end
91
+
92
+ # Calculates hash code according to all attributes.
93
+ # @return [Integer] Hash code
94
+ def hash
95
+ [id].hash
96
+ end
97
+
98
+ # Builds the object from hash
99
+ # @param [Hash] attributes Model attributes in the form of hash
100
+ # @return [Object] Returns the model itself
101
+ def self.build_from_hash(attributes)
102
+ new.build_from_hash(attributes)
103
+ end
104
+
105
+ # Builds the object from hash
106
+ # @param [Hash] attributes Model attributes in the form of hash
107
+ # @return [Object] Returns the model itself
108
+ def build_from_hash(attributes)
109
+ return nil unless attributes.is_a?(Hash)
110
+ self.class.openapi_types.each_pair do |key, type|
111
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
112
+ self.send("#{key}=", nil)
113
+ elsif type =~ /\AArray<(.*)>/i
114
+ # check to ensure the input is an array given that the attribute
115
+ # is documented as an array but the input is not
116
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
117
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
118
+ end
119
+ elsif !attributes[self.class.attribute_map[key]].nil?
120
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
121
+ end
122
+ end
123
+
124
+ self
125
+ end
126
+
127
+ # Deserializes the data based on type
128
+ # @param string type Data type
129
+ # @param string value Value to be deserialized
130
+ # @return [Object] Deserialized data
131
+ def _deserialize(type, value)
132
+ case type.to_sym
133
+ when :Time
134
+ Time.parse(value)
135
+ when :Date
136
+ Date.parse(value)
137
+ when :String
138
+ value.to_s
139
+ when :Integer
140
+ value.to_i
141
+ when :Float
142
+ value.to_f
143
+ when :Boolean
144
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
145
+ true
146
+ else
147
+ false
148
+ end
149
+ when :Object
150
+ # generic object (usually a Hash), return directly
151
+ value
152
+ when /\AArray<(?<inner_type>.+)>\z/
153
+ inner_type = Regexp.last_match[:inner_type]
154
+ value.map { |v| _deserialize(inner_type, v) }
155
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
156
+ k_type = Regexp.last_match[:k_type]
157
+ v_type = Regexp.last_match[:v_type]
158
+ {}.tap do |hash|
159
+ value.each do |k, v|
160
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
161
+ end
162
+ end
163
+ else # model
164
+ # models (e.g. Pet) or oneOf
165
+ klass = Klaviyo.const_get(type)
166
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
167
+ end
168
+ end
169
+
170
+ # Returns the string representation of the object
171
+ # @return [String] String presentation of the object
172
+ def to_s
173
+ to_hash.to_s
174
+ end
175
+
176
+ # to_body is an alias to to_hash (backward compatibility)
177
+ # @return [Hash] Returns the object in the form of hash
178
+ def to_body
179
+ to_hash
180
+ end
181
+
182
+ # Returns the object in the form of hash
183
+ # @return [Hash] Returns the object in the form of hash
184
+ def to_hash
185
+ hash = {}
186
+ self.class.attribute_map.each_pair do |attr, param|
187
+ value = self.send(attr)
188
+ if value.nil?
189
+ is_nullable = self.class.openapi_nullable.include?(attr)
190
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
191
+ end
192
+
193
+ hash[param] = _to_hash(value)
194
+ end
195
+ hash
196
+ end
197
+
198
+ # Outputs non-array value in the form of hash
199
+ # For object, use to_hash. Otherwise, just return the value
200
+ # @param [Object] value Any valid value
201
+ # @return [Hash] Returns the value in the form of hash
202
+ def _to_hash(value)
203
+ if value.is_a?(Array)
204
+ value.compact.map { |v| _to_hash(v) }
205
+ elsif value.is_a?(Hash)
206
+ {}.tap do |hash|
207
+ value.each { |k, v| hash[k] = _to_hash(v) }
208
+ end
209
+ elsif value.respond_to? :to_hash
210
+ value.to_hash
211
+ else
212
+ value
213
+ end
214
+ end
215
+
216
+ end
217
+
218
+ end
data/lib/klaviyo_sdk.rb CHANGED
@@ -18,6 +18,8 @@ require 'klaviyo_sdk/configuration'
18
18
 
19
19
  # Models
20
20
  require 'klaviyo_sdk/models/campaign'
21
+ require 'klaviyo_sdk/models/campaign_lists'
22
+ require 'klaviyo_sdk/models/campaigns'
21
23
  require 'klaviyo_sdk/models/check_membership_request'
22
24
  require 'klaviyo_sdk/models/delete_email'
23
25
  require 'klaviyo_sdk/models/delete_person'
@@ -31,6 +33,7 @@ require 'klaviyo_sdk/models/inline_object'
31
33
  require 'klaviyo_sdk/models/inline_object3'
32
34
  require 'klaviyo_sdk/models/inline_object4'
33
35
  require 'klaviyo_sdk/models/inline_object5'
36
+ require 'klaviyo_sdk/models/inline_response200'
34
37
  require 'klaviyo_sdk/models/metric'
35
38
  require 'klaviyo_sdk/models/metric_export'
36
39
  require 'klaviyo_sdk/models/metric_timeline'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: klaviyo_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.3.20220329
4
+ version: 1.0.4.20220329
5
5
  platform: ruby
6
6
  authors:
7
7
  - Klaviyo Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-05-04 00:00:00.000000000 Z
11
+ date: 2022-08-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: retriable
@@ -55,42 +55,6 @@ files:
55
55
  - Gemfile
56
56
  - README.md
57
57
  - Rakefile
58
- - docs/Campaign.md
59
- - docs/CampaignsApi.md
60
- - docs/CheckMembershipRequest.md
61
- - docs/DataPrivacyApi.md
62
- - docs/DeleteEmail.md
63
- - docs/DeletePerson.md
64
- - docs/DeletePhone.md
65
- - docs/DeprecatedGetListResponse.md
66
- - docs/DeprecatedGetListResponseData.md
67
- - docs/GlobalExclusionResponseData.md
68
- - docs/IdentifyPayload.md
69
- - docs/IdentifyPayloadProperties.md
70
- - docs/InlineObject.md
71
- - docs/InlineObject3.md
72
- - docs/InlineObject4.md
73
- - docs/InlineObject5.md
74
- - docs/ListsSegmentsApi.md
75
- - docs/Metric.md
76
- - docs/MetricExport.md
77
- - docs/MetricTimeline.md
78
- - docs/MetricTimelineData.md
79
- - docs/MetricsApi.md
80
- - docs/Person.md
81
- - docs/PrivacyEmail.md
82
- - docs/PrivacyId.md
83
- - docs/PrivacyPhone.md
84
- - docs/ProfilesApi.md
85
- - docs/RenderedTemplate.md
86
- - docs/Template.md
87
- - docs/TemplatesApi.md
88
- - docs/TrackIdentifyApi.md
89
- - docs/TrackPayload.md
90
- - docs/TrackPayloadCustomerProperties.md
91
- - docs/TrackPayloadProperties.md
92
- - git_push.sh
93
- - klaviyo_sdk-1.0.3.2022.03.29.gem
94
58
  - klaviyo_sdk.gemspec
95
59
  - lib/klaviyo_sdk.rb
96
60
  - lib/klaviyo_sdk/api/campaigns_api.rb
@@ -104,6 +68,8 @@ files:
104
68
  - lib/klaviyo_sdk/api_error.rb
105
69
  - lib/klaviyo_sdk/configuration.rb
106
70
  - lib/klaviyo_sdk/models/campaign.rb
71
+ - lib/klaviyo_sdk/models/campaign_lists.rb
72
+ - lib/klaviyo_sdk/models/campaigns.rb
107
73
  - lib/klaviyo_sdk/models/check_membership_request.rb
108
74
  - lib/klaviyo_sdk/models/delete_email.rb
109
75
  - lib/klaviyo_sdk/models/delete_person.rb
@@ -117,6 +83,7 @@ files:
117
83
  - lib/klaviyo_sdk/models/inline_object3.rb
118
84
  - lib/klaviyo_sdk/models/inline_object4.rb
119
85
  - lib/klaviyo_sdk/models/inline_object5.rb
86
+ - lib/klaviyo_sdk/models/inline_response200.rb
120
87
  - lib/klaviyo_sdk/models/metric.rb
121
88
  - lib/klaviyo_sdk/models/metric_export.rb
122
89
  - lib/klaviyo_sdk/models/metric_timeline.rb
@@ -132,43 +99,6 @@ files:
132
99
  - lib/klaviyo_sdk/models/track_payload_customer_properties.rb
133
100
  - lib/klaviyo_sdk/models/track_payload_properties.rb
134
101
  - lib/klaviyo_sdk/version.rb
135
- - spec/api/campaigns_api_spec.rb
136
- - spec/api/data_privacy_api_spec.rb
137
- - spec/api/lists_segments_api_spec.rb
138
- - spec/api/metrics_api_spec.rb
139
- - spec/api/profiles_api_spec.rb
140
- - spec/api/templates_api_spec.rb
141
- - spec/api/track_identify_api_spec.rb
142
- - spec/api_client_spec.rb
143
- - spec/configuration_spec.rb
144
- - spec/models/campaign_spec.rb
145
- - spec/models/check_membership_request_spec.rb
146
- - spec/models/delete_email_spec.rb
147
- - spec/models/delete_person_spec.rb
148
- - spec/models/delete_phone_spec.rb
149
- - spec/models/deprecated_get_list_response_data_spec.rb
150
- - spec/models/deprecated_get_list_response_spec.rb
151
- - spec/models/global_exclusion_response_data_spec.rb
152
- - spec/models/identify_payload_properties_spec.rb
153
- - spec/models/identify_payload_spec.rb
154
- - spec/models/inline_object3_spec.rb
155
- - spec/models/inline_object4_spec.rb
156
- - spec/models/inline_object5_spec.rb
157
- - spec/models/inline_object_spec.rb
158
- - spec/models/metric_export_spec.rb
159
- - spec/models/metric_spec.rb
160
- - spec/models/metric_timeline_data_spec.rb
161
- - spec/models/metric_timeline_spec.rb
162
- - spec/models/person_spec.rb
163
- - spec/models/privacy_email_spec.rb
164
- - spec/models/privacy_id_spec.rb
165
- - spec/models/privacy_phone_spec.rb
166
- - spec/models/rendered_template_spec.rb
167
- - spec/models/template_spec.rb
168
- - spec/models/track_payload_customer_properties_spec.rb
169
- - spec/models/track_payload_properties_spec.rb
170
- - spec/models/track_payload_spec.rb
171
- - spec/spec_helper.rb
172
102
  homepage: https://www.klaviyo.com/
173
103
  licenses:
174
104
  - Unlicense
@@ -190,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
190
120
  - !ruby/object:Gem::Version
191
121
  version: '0'
192
122
  requirements: []
193
- rubygems_version: 3.2.3
123
+ rubygems_version: 3.3.7
194
124
  signing_key:
195
125
  specification_version: 4
196
126
  summary: You heard us, a Ruby wrapper for the Klaviyo API
data/docs/Campaign.md DELETED
@@ -1,38 +0,0 @@
1
- # Klaviyo::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&lt;String, Object&gt;** | | [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 = Klaviyo::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
-