klaviyo_sdk 1.0.3.20220329 → 1.0.4.20220329

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c77f994257e4610a1394c7cec1321e2ac26990cfe4ca24f19b9e00e72807493
-  data.tar.gz: ec0aec23e49bad119b958c3cfc7333b7a933077657fb8a5fadb30da90f436477
+  metadata.gz: 31d15ae559ae4623fbf67d23e13065e9d681beb0857187019f4e0ef5ffdb494c
+  data.tar.gz: d824f8c18899a9549fdcde77c2489f523603ff2a292d58e28e9f5cfadbcf4c1a
 SHA512:
-  metadata.gz: 6766d3434eb770101a036d367d77feea6ad5ede13967aac7b9567572c9bfbeec18105b79d5bbbb10162ea94df1194a1c3ca3f7d2e69f0db1172c63778beafdda
-  data.tar.gz: b165fd1b7857a695f14124a3a4a88723a91df60133bcd3e60db9df3fd27745927fcdc31a6e4913ee0b8a8b88da8cee5082350322d20ffeaaed8fdcd0baa0c428
+  metadata.gz: a284b7b92afa55f941b3048c6d7d20d6723c124161921281e3ab58642f6e4a393530849962b66342d3355163d604485682d60625ef403551c7e12baa93e9ae69
+  data.tar.gz: 2eabe9255ad433ecaddf6ae19f653661495d81a0d5b588e360a69cd83ec8bd8d9a199e9a1e0d0ea9ce768d702a5df656672a58e872f299b8196d6640cd24693b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## CHANGELOG
 
+### 1.0.4.20220329
+* Add support for /v2/people/search endpoint
+* Update campaign and campaign_lists models
+
+### 1.0.3.20220329
+* Fix one of the error codes that the retry logic relies on (from 400 to 429)
+
 ### 1.0.2.20220329
 * Use Klaviyo as the module name for the sdk instead of the more generic Client
 

data/README.md

@@ -1,6 +1,6 @@
 # Klaviyo Ruby SDK
 
-- SDK version: 1.0.3.20220329
+- SDK version: 1.0.4.20220329
 
 ## Helpful Resources
 
@@ -60,13 +60,13 @@ gem build klaviyo_sdk.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./klaviyo_sdk-1.0.3.20220329.gem
+gem install ./klaviyo_sdk-1.0.4.20220329.gem
 ```
 
 
 Finally add this to the Gemfile:
 
-    gem 'klaviyo_sdk', '~> 1.0.3.20220329'
+    gem 'klaviyo_sdk', '~> 1.0.4.20220329'
 
 To install directly from rubygems:
 
@@ -792,6 +792,28 @@ response = Klaviyo::Profiles.get_profile(person_id)
 
 
 
+#### [Get Profile ID](https://developers.klaviyo.com/en/reference/get-profile-id)
+
+```ruby
+Klaviyo::Profiles.get_profile_id(opts)
+```
+
+#### Example:
+```ruby
+opts = {
+  query_params: {
+    email: 'george.washington@klaviyo.com',
+    phone_number: '555-555-5555',
+    external_id: 'EXTERNAL_ID'
+  }
+}
+
+response = Klaviyo::Profiles.get_profile_id(opts)
+```
+
+
+
+
 #### [Get Profile's Events for a Specific Metric](https://developers.klaviyo.com/en/reference/profile-metric-timeline)
 
 ```ruby

data/klaviyo_sdk.gemspec

@@ -17,7 +17,7 @@ require "klaviyo_sdk/version"
 
 Gem::Specification.new do |s|
   s.name        = "klaviyo_sdk"
-  s.version     = "1.0.3.20220329"
+  s.version     = "1.0.4.20220329"
   s.authors     = ['Klaviyo Team']
   s.email       = ['libraries@klaviyo.com']
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'

data/lib/klaviyo_sdk/api/data_privacy_api.rb

@@ -20,7 +20,7 @@ module Klaviyo
       @api_client = api_client
     end
     # Request a Deletion
-    # Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
+    # Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your Private API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :body 
     # @return [String]
@@ -30,7 +30,7 @@ module Klaviyo
     end
 
     # Request a Deletion
-    # Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
+    # Request a data privacy-compliant deletion for the person record corresponding to an email address, phone number, or person identifier.   **If multiple person records exist for the provided identifier, only one of them will be deleted.**  The arguments should be sent as content type application/json.           Note that only **one** identifier (email, phone_number, or person_id) can be specified.  In addition to your Private API key, you need to set exactly one of the following parameters: `email`, `phone_number`, `or person_id`, along with the associated `string` value.   Examples:  Email:    `{\"email\":\"abraham.lincoln@klaviyo.com\"}`    Phone Number:      `{\"phone_number\":\"+13239169023\"}`    Person ID:      `{\"person_id\":\"PERSON_ID\"}` 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :body 
     # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers

data/lib/klaviyo_sdk/api/profiles_api.rb

@@ -146,6 +146,72 @@ module Klaviyo
       return data, status_code, headers
     end
 
+    # Get Profile ID
+    # Get a profile's Klaviyo ID given exactly one corresponding identifier: `email`, `phone_number`, or `external_id`. NOTE: calling this endpoint with multiple identifiers will result in an error.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email 
+    # @option opts [String] :phone_number 
+    # @option opts [String] :external_id 
+    # @return [InlineResponse200]
+    def get_profile_id(opts = {})
+      data, _status_code, _headers = get_profile_id_with_http_info(opts)
+      data
+    end
+
+    # Get Profile ID
+    # Get a profile's Klaviyo ID given exactly one corresponding identifier: `email`, `phone_number`, or `external_id`. NOTE: calling this endpoint with multiple identifiers will result in an error.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email 
+    # @option opts [String] :phone_number 
+    # @option opts [String] :external_id 
+    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
+    def get_profile_id_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfilesApi.get_profile_id ...'
+      end
+      # resource path
+      local_var_path = '/v2/people/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
+      query_params[:'phone_number'] = opts[:'phone_number'] if !opts[:'phone_number'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse200'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProfilesApi.get_profile_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProfilesApi#get_profile_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Profile's Events for a Specific Metric
     # Returns a person's batched timeline for one specific event type.
     # @param person_id [String] 

data/lib/klaviyo_sdk/api_client.rb

@@ -31,7 +31,7 @@ module Klaviyo
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "klaviyo-ruby/1.0.3.20220329"
+      @user_agent = "klaviyo-ruby/1.0.4.20220329"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/klaviyo_sdk/models/campaign.rb

@@ -27,16 +27,56 @@ module Klaviyo
 
     attr_accessor :from_name
 
-    attr_accessor :list_id
+    attr_accessor :lists
 
-    attr_accessor :template
+    attr_accessor :excluded_lists
 
     attr_accessor :status
 
+    attr_accessor :status_id
+
+    attr_accessor :status_label
+
     attr_accessor :sent_at
 
+    attr_accessor :send_time
+
     attr_accessor :created
 
+    attr_accessor :updated
+
+    attr_accessor :num_recipients
+
+    attr_accessor :campaign_type
+
+    attr_accessor :is_segmented
+
+    attr_accessor :message_type
+
+    attr_accessor :template
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,11 +86,20 @@ module Klaviyo
         :'subject' => :'subject',
         :'from_email' => :'from_email',
         :'from_name' => :'from_name',
-        :'list_id' => :'list_id',
-        :'template' => :'template',
+        :'lists' => :'lists',
+        :'excluded_lists' => :'excluded_lists',
         :'status' => :'status',
+        :'status_id' => :'status_id',
+        :'status_label' => :'status_label',
         :'sent_at' => :'sent_at',
-        :'created' => :'created'
+        :'send_time' => :'send_time',
+        :'created' => :'created',
+        :'updated' => :'updated',
+        :'num_recipients' => :'num_recipients',
+        :'campaign_type' => :'campaign_type',
+        :'is_segmented' => :'is_segmented',
+        :'message_type' => :'message_type',
+        :'template' => :'template'
       }
     end
 
@@ -68,17 +117,27 @@ module Klaviyo
         :'subject' => :'String',
         :'from_email' => :'String',
         :'from_name' => :'String',
-        :'list_id' => :'String',
-        :'template' => :'Hash<String, Object>',
+        :'lists' => :'Array<CampaignLists>',
+        :'excluded_lists' => :'Array<CampaignLists>',
         :'status' => :'String',
-        :'sent_at' => :'String',
-        :'created' => :'String'
+        :'status_id' => :'Integer',
+        :'status_label' => :'String',
+        :'sent_at' => :'Time',
+        :'send_time' => :'Time',
+        :'created' => :'Time',
+        :'updated' => :'Time',
+        :'num_recipients' => :'Integer',
+        :'campaign_type' => :'String',
+        :'is_segmented' => :'Boolean',
+        :'message_type' => :'String',
+        :'template' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'sent_at',
       ])
     end
 
@@ -121,13 +180,15 @@ module Klaviyo
         self.from_name = attributes[:'from_name']
       end
 
-      if attributes.key?(:'list_id')
-        self.list_id = attributes[:'list_id']
+      if attributes.key?(:'lists')
+        if (value = attributes[:'lists']).is_a?(Array)
+          self.lists = value
+        end
       end
 
-      if attributes.key?(:'template')
-        if (value = attributes[:'template']).is_a?(Hash)
-          self.template = value
+      if attributes.key?(:'excluded_lists')
+        if (value = attributes[:'excluded_lists']).is_a?(Array)
+          self.excluded_lists = value
         end
       end
 
@@ -135,28 +196,138 @@ module Klaviyo
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'status_id')
+        self.status_id = attributes[:'status_id']
+      end
+
+      if attributes.key?(:'status_label')
+        self.status_label = attributes[:'status_label']
+      end
+
       if attributes.key?(:'sent_at')
         self.sent_at = attributes[:'sent_at']
       end
 
+      if attributes.key?(:'send_time')
+        self.send_time = attributes[:'send_time']
+      end
+
       if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      end
+
+      if attributes.key?(:'num_recipients')
+        self.num_recipients = attributes[:'num_recipients']
+      end
+
+      if attributes.key?(:'campaign_type')
+        self.campaign_type = attributes[:'campaign_type']
+      end
+
+      if attributes.key?(:'is_segmented')
+        self.is_segmented = attributes[:'is_segmented']
+      end
+
+      if attributes.key?(:'message_type')
+        self.message_type = attributes[:'message_type']
+      end
+
+      if attributes.key?(:'template')
+        if (value = attributes[:'template']).is_a?(Hash)
+          self.template = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@status_id.nil? && @status_id > 13
+        invalid_properties.push('invalid value for "status_id", must be smaller than or equal to 13.')
+      end
+
+      if !@status_id.nil? && @status_id < 0
+        invalid_properties.push('invalid value for "status_id", must be greater than or equal to 0.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "cancelled", "queued", "cancelled_no_recipients_smart_sending", "cancelled_no_recipients_scheduling", "cancelled_account_disabled", "scheduling", "sending", "sending_timezones", "variations_sent", "preparing_to_schedule", "cancelled_internal_error"])
+      return false unless status_validator.valid?(@status)
+      return false if !@status_id.nil? && @status_id > 13
+      return false if !@status_id.nil? && @status_id < 0
+      status_label_validator = EnumAttributeValidator.new('String', ["Scheduled", "Sent", "Draft", "Cancelled", "Adding Recipients", "Sending", "Variations Sent", "Sending Segments", "Cancelled: Smart Sending", "Preparing to send", "Cancelled: Account Disabled", "Cancelled: No Recipients", "Preparing to schedule", "Cancelled: Internal Error"])
+      return false unless status_label_validator.valid?(@status_label)
+      campaign_type_validator = EnumAttributeValidator.new('String', ["Timezone", "REGULAR", "A/B Content", "A/B Send Time", "Batch", "A/B Segments by Send Time", "A/B Segments by Send Time (STO)", "SMS Segments by Message Per Second"])
+      return false unless campaign_type_validator.valid?(@campaign_type)
+      message_type_validator = EnumAttributeValidator.new('String', ["email", "sms", "push"])
+      return false unless message_type_validator.valid?(@message_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "sent", "cancelled", "queued", "cancelled_no_recipients_smart_sending", "cancelled_no_recipients_scheduling", "cancelled_account_disabled", "scheduling", "sending", "sending_timezones", "variations_sent", "preparing_to_schedule", "cancelled_internal_error"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status_id Value to be assigned
+    def status_id=(status_id)
+      if !status_id.nil? && status_id > 13
+        fail ArgumentError, 'invalid value for "status_id", must be smaller than or equal to 13.'
+      end
+
+      if !status_id.nil? && status_id < 0
+        fail ArgumentError, 'invalid value for "status_id", must be greater than or equal to 0.'
+      end
+
+      @status_id = status_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status_label Object to be assigned
+    def status_label=(status_label)
+      validator = EnumAttributeValidator.new('String', ["Scheduled", "Sent", "Draft", "Cancelled", "Adding Recipients", "Sending", "Variations Sent", "Sending Segments", "Cancelled: Smart Sending", "Preparing to send", "Cancelled: Account Disabled", "Cancelled: No Recipients", "Preparing to schedule", "Cancelled: Internal Error"])
+      unless validator.valid?(status_label)
+        fail ArgumentError, "invalid value for \"status_label\", must be one of #{validator.allowable_values}."
+      end
+      @status_label = status_label
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] campaign_type Object to be assigned
+    def campaign_type=(campaign_type)
+      validator = EnumAttributeValidator.new('String', ["Timezone", "REGULAR", "A/B Content", "A/B Send Time", "Batch", "A/B Segments by Send Time", "A/B Segments by Send Time (STO)", "SMS Segments by Message Per Second"])
+      unless validator.valid?(campaign_type)
+        fail ArgumentError, "invalid value for \"campaign_type\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_type = campaign_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] message_type Object to be assigned
+    def message_type=(message_type)
+      validator = EnumAttributeValidator.new('String', ["email", "sms", "push"])
+      unless validator.valid?(message_type)
+        fail ArgumentError, "invalid value for \"message_type\", must be one of #{validator.allowable_values}."
+      end
+      @message_type = message_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -168,11 +339,20 @@ module Klaviyo
           subject == o.subject &&
           from_email == o.from_email &&
           from_name == o.from_name &&
-          list_id == o.list_id &&
-          template == o.template &&
+          lists == o.lists &&
+          excluded_lists == o.excluded_lists &&
           status == o.status &&
+          status_id == o.status_id &&
+          status_label == o.status_label &&
           sent_at == o.sent_at &&
-          created == o.created
+          send_time == o.send_time &&
+          created == o.created &&
+          updated == o.updated &&
+          num_recipients == o.num_recipients &&
+          campaign_type == o.campaign_type &&
+          is_segmented == o.is_segmented &&
+          message_type == o.message_type &&
+          template == o.template
     end
 
     # @see the `==` method
@@ -184,7 +364,7 @@ module Klaviyo
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [object, id, name, subject, from_email, from_name, list_id, template, status, sent_at, created].hash
+      [object, id, name, subject, from_email, from_name, lists, excluded_lists, status, status_id, status_label, sent_at, send_time, created, updated, num_recipients, campaign_type, is_segmented, message_type, template].hash
     end
 
     # Builds the object from hash