iterable-api-client 0.5.1 → 0.6.2

data/lib/iterable/export.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -54,9 +56,19 @@ module Iterable
     # @param only_fields [Array[String]] Array of fields to only export
     # @param omit_fields [Array[String]] Array of fields to omit
     # @param data_fields [Hash] Additional device data fields
+    # @param campaign_id [String] The ID of the campaign
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Export]
+    sig do
+      params(
+        data_type: String,
+        only_fields: T::Array[String],
+        omit_fields: T::Array[String],
+        campaign_id: T.nilable(String),
+        conf: T.nilable(Iterable::Config)
+      ).void
+    end
     def initialize(data_type, only_fields = [], omit_fields = [], campaign_id = nil, conf = nil) # rubocop:disable Metrics/ParameterLists
       @data_type = data_type
       @only_fields = only_fields
@@ -71,6 +83,7 @@ module Iterable
     # @example Formats are currently csv or json
     #
     # @return [Exception] Raises an exception
+    sig { overridable.returns(String) }
     def format
       raise '#format must be implemented in child class'
     end
@@ -83,6 +96,12 @@ module Iterable
     # @param end_time [Time] The end time of the data to export
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        start_time: Time,
+        end_time: Time
+      ).returns(Iterable::Response)
+    end
     def export(start_time, end_time)
       params = {
         startDateTime: start_time.strftime(Iterable::Export::DATE_FORMAT),
@@ -98,32 +117,42 @@ module Iterable
     # @param range [Iterable::Export::RANGES] A valid range to export data for
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        range: String
+      ).returns(Iterable::Response)
+    end
     def export_range(range = Iterable::Export::TODAY)
       params = { range: range }
       Iterable.request(conf, base_path, request_params(params)).get
     end
 
+    sig { returns(String) }
     protected def base_path
       "/export/data.#{format}"
     end
 
+    sig { params(params: Hash).returns(Hash) }
     protected def request_params(params = {})
       default_params.merge params
     end
 
+    sig { returns(T::Boolean) }
     protected def only_fields?
-      @only_fields&.length.to_i.positive?
+      only_fields.length.to_i.positive?
     end
 
+    sig { returns(T::Boolean) }
     protected def omit_fields?
-      @omit_fields&.length.to_i.positive?
+      omit_fields.length.to_i.positive?
     end
 
+    sig { returns(Hash) }
     protected def default_params
-      params = { dataTypeName: @data_type }
-      params[:onlyFields] = @only_fields if only_fields?
-      params[:omitFields] = @omit_fields.join(',') if omit_fields?
-      params[:campaignId] = @campaign_id if @campaign_id
+      params = { dataTypeName: data_type }
+      params[:onlyFields] = only_fields if only_fields?
+      params[:omitFields] = omit_fields.join(',') if omit_fields?
+      params[:campaignId] = campaign_id if campaign_id
       params
     end
   end

data/lib/iterable/in_app.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -20,6 +22,13 @@ module Iterable
     # @param attrs [Hash] Hash of query attributes like platform, SDKVersion, etc.
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        count: Integer,
+        attrs: T.any(Integer, String)
+      ).returns(Iterable::Response)
+    end
     def messages_for_email(email, count: 1, **attrs)
       attrs[:email] = email
       attrs[:count] = count
@@ -30,11 +39,18 @@ module Iterable
     #
     # Get in-app messages for a user by user_id
     #
-    # @param email [String] *required* Email of user who received the message to view. Required if no user_id present.
+    # @param user_id [String] *required* ID of user who received the message to view.
     # @param count [Integer] Number of messages to return, defaults to 1
     # @param attrs [Hash] Hash of query attributes like platform, SDKVersion, etc.
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        user_id: T.any(String, Integer),
+        count: Integer,
+        attrs: T.any(Integer, String)
+      ).returns(Iterable::Response)
+    end
     def messages_for_user_id(user_id, count: 1, **attrs)
       attrs[:userId] = user_id
       attrs[:count] = count
@@ -46,12 +62,18 @@ module Iterable
     # Send an In-App notification to a specific user. User Email or ID along
     # with campaign ID must be provided
     #
-    # @param email [String] (optional) User email used to identify user
     # @param campaign_id [Integer] Campaign ID
     # @param attrs [Hash] Additional data to update or add
+    # @param email [String] (optional) User email used to identify user
     #
     # @return [Iterable::Response] A response object
-    #
+    sig do
+      params(
+        campaign_id: T.any(String, Integer),
+        attrs: T::Hash[T.any(Symbol, String), T.any(Integer, String)],
+        email: T.nilable(String)
+      ).returns(Iterable::Response)
+    end
     def target(campaign_id:, attrs: {}, email: nil)
       attrs['recipientEmail'] = email if email
       attrs['campaignId'] = campaign_id
@@ -64,20 +86,27 @@ module Iterable
     # Must include either an email address AND campaignId, or
     # just a scheduledMessageId provided in the attrs
     #
-    # @param email [String] User email to cancel push
-    # @param campaignId [Integer] campaignID used to cancel push
+    # @param campaign_id [Integer] campaignID used to cancel push
     # @param attrs [Hash] Additional data to update or add
+    # @param email [String] User email to cancel push
     #
     # @return [Iterable::Response] A response object
     #
     # @note An email or UserId is required
+    sig do
+      params(
+        campaign_id: T.nilable(T.any(String, Integer)),
+        attrs: T::Hash[T.any(Symbol, String), T.any(Integer, String)],
+        email: T.nilable(String)
+      ).returns(Iterable::Response)
+    end
     def cancel(campaign_id: nil, attrs: {}, email: nil)
       attrs['email'] = email if email
       attrs['campaignId'] = campaign_id if campaign_id
       Iterable.request(conf, '/push/cancel').post(attrs)
     end
 
-    private def messages(**attrs)
+    private def messages(attrs = {})
       Iterable.request(conf, '/inApp/getMessages', attrs).get
     end
   end

data/lib/iterable/json_exporter.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -16,6 +18,7 @@ module Iterable
     # Format to use for exporting
     #
     # @return [String] Format of export
+    sig { override.returns(String) }
     def format
       'json'
     end

data/lib/iterable/lists.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -17,6 +19,7 @@ module Iterable
     # Get all lists
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def all
       Iterable.request(conf, '/lists').get
     end
@@ -28,6 +31,7 @@ module Iterable
     # @param name [String] The name of the list to create
     #
     # @return [Iterable::Response] A response object
+    sig { params(name: String).returns(Iterable::Response) }
     def create(name)
       Iterable.request(conf, '/lists').post(name: name)
     end
@@ -36,9 +40,10 @@ module Iterable
     #
     # Delete an existing list given a list id
     #
-    # @param name [String|Integer] The id of the list to delete
+    # @param list_id [String|Integer] The id of the list to delete
     #
     # @return [Iterable::Response] A response object
+    sig { params(list_id: T.any(String, Integer)).returns(Iterable::Response) }
     def delete(list_id)
       Iterable.request(conf, "/lists/#{list_id}").delete
     end
@@ -50,6 +55,7 @@ module Iterable
     # @param list_id [String|Integer] The id of the list
     #
     # @return [Iterable::Response] A response object
+    sig { params(list_id: T.any(String, Integer)).returns(Iterable::Response) }
     def users(list_id)
       Iterable.request(conf, '/lists/getUsers', listId: list_id).get
     end
@@ -59,9 +65,19 @@ module Iterable
     # Subscribe users to a list
     #
     # @param list_id [String|Integer] The id of the list
-    # @param subscribes [Array[Hash]] An array of hashes of user emails and data fields
+    # @param subscribers [Array[Hash]] An array of hashes of user emails and data fields
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        list_id: T.any(String, Integer),
+        subscribers: T::Array[
+          T::Hash[
+            T.any(Symbol, String), T.any(Symbol, String)
+          ]
+        ]
+      ).returns(Iterable::Response)
+    end
     def subscribe(list_id, subscribers = [])
       attrs = {
         listId: list_id,
@@ -75,9 +91,19 @@ module Iterable
     # Subscribe users to a list
     #
     # @param list_id [String|Integer] The id of the list
-    # @param subscribes [Array[Hash]] An array of hashes with an email
+    # @param subscribers [Array[Hash]] An array of hashes with an email
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        list_id: T.any(String, Integer),
+        subscribers: T::Array[
+          T::Hash[
+            T.any(Symbol, String), T.any(Symbol, String)
+          ]
+        ]
+      ).returns(Iterable::Response)
+    end
     def unsubscribe(list_id, subscribers = [])
       attrs = {
         listId: list_id,

data/lib/iterable/message_types.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -24,6 +26,7 @@ module Iterable
     # Get all message_types
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def all
       Iterable.request(conf, '/messageTypes').get
     end

data/lib/iterable/metadata.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -17,6 +19,7 @@ module Iterable
     # Get metadata
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def get
       Iterable.request(conf, '/metadata').get
     end

data/lib/iterable/metadata_table.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -22,6 +24,12 @@ module Iterable
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::MetadataTable]
+    sig do
+      params(
+        name: String,
+        conf: T.nilable(Iterable::Config)
+      ).void
+    end
     def initialize(name, conf = nil)
       @name = name
       super conf
@@ -31,9 +39,10 @@ module Iterable
     #
     # Get metadata table keys
     #
-    # @params next_marker [String] next result set id if more hits exist
+    # @param next_marker [String] next result set id if more hits exist
     #
     # @return [Iterable::Response] A response object
+    sig { params(next_marker: T.nilable(String)).returns(Iterable::Response) }
     def list_keys(next_marker = nil)
       params = {}
       params['nextMarker'] = next_marker if next_marker
@@ -45,6 +54,7 @@ module Iterable
     # Delete metadata table
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def delete
       Iterable.request(conf, base_path).delete
     end
@@ -57,6 +67,15 @@ module Iterable
     # @param value [Hash] Value of metadata key as a hash of key/value data
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        key: String,
+        value: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Float, Integer)
+        ]
+      ).returns(Iterable::Response)
+    end
     def add(key, value = {})
       Iterable.request(conf, base_path(key)).put(value: value)
     end
@@ -68,6 +87,7 @@ module Iterable
     # @param key [String] Key of metadata to get
     #
     # @return [Iterable::Response] A response object
+    sig { params(key: String).returns(Iterable::Response) }
     def get(key)
       Iterable.request(conf, base_path(key)).get
     end
@@ -79,6 +99,7 @@ module Iterable
     # @param key [String] Key of metadata to delete
     #
     # @return [Iterable::Response] A response object
+    sig { params(key: String).returns(Iterable::Response) }
     def remove(key)
       Iterable.request(conf, base_path(key)).delete
     end

data/lib/iterable/push.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -13,11 +15,21 @@ module Iterable
     #
     # Send a push notification to a specific user
     #
-    # @param email [String] (optional) User email used to identify user
     # @param campaign_id [Integer] Campaign ID
+    # @param email [String] (optional) User email used to identify user
     # @param attrs [Hash] Additional data to update or add
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        campaign_id: T.any(String, Integer),
+        email: T.nilable(String),
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def target(campaign_id:, email: nil, attrs: {})
       attrs['recipientEmail'] = email if email
       attrs['campaignId'] = campaign_id
@@ -31,12 +43,22 @@ module Iterable
     # just a scheduledMessageId provided in the attrs
     #
     # @param email [String] User email to cancel push
-    # @param campaignId [Integer] campaignID used to cancel push
+    # @param campaign_id [Integer] campaignID used to cancel push
     # @param attrs [Hash] Additional data to update or add
     #
     # @return [Iterable::Response] A response object
     #
     # @note An email or UserId is required
+    sig do
+      params(
+        email: T.nilable(String),
+        campaign_id: T.nilable(T.any(String, Integer)),
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def cancel(email: nil, campaign_id: nil, attrs: {})
       attrs['email'] = email if email
       attrs['campaignId'] = campaign_id if campaign_id

data/lib/iterable/push_templates.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -20,6 +22,15 @@ module Iterable
     # @param params [Hash] Additional params to use such as locale
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        template_id: T.any(String, Integer),
+        params: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def get(template_id, params = {})
       params['templateId'] = template_id
       Iterable.request(conf, '/templates/push/get', params).get
@@ -46,6 +57,15 @@ module Iterable
     # @param attrs [Hash] Update attributes
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        client_template_id: T.any(String, Integer),
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def upsert(client_template_id, attrs = {})
       attrs['clientTemplateId'] = client_template_id
       Iterable.request(conf, '/templates/push/upsert').post(attrs)

data/lib/iterable/request.rb

@@ -1,9 +1,13 @@
+# typed: false
+
 require 'openssl'
 require 'uri'
 
 module Iterable
   # @!visibility private
   class Request
+    extend T::Sig
+
     DEFAULT_OPTIONS = {
       use_ssl: true,
       verify_ssl: true,
@@ -15,6 +19,13 @@ module Iterable
       'content-type' => 'application/json'
     }.freeze
 
+    sig do
+      params(
+        config: Iterable::Config,
+        path: String,
+        params: Hash
+      ).void
+    end
     def initialize(config, path, params = {})
       @config = config
       @uri = build_uri(path, params)
@@ -22,22 +33,27 @@ module Iterable
       setup_http(@net)
     end
 
+    sig { params(headers: Hash).returns(Iterable::Response) }
     def get(headers = {})
       execute :get, {}, headers
     end
 
+    sig { params(body: Hash, headers: Hash).returns(Iterable::Response) }
     def post(body = {}, headers = {})
       execute :post, body, headers
     end
 
+    sig { params(body: Hash, headers: Hash).returns(Iterable::Response) }
     def put(body = {}, headers = {})
       execute :put, body, headers
     end
 
+    sig { params(body: Hash, headers: Hash).returns(Iterable::Response) }
     def patch(body = {}, headers = {})
       execute :patch, body, headers
     end
 
+    sig { params(body: Hash, headers: Hash).returns(Iterable::Response) }
     def delete(body = {}, headers = {})
       execute :delete, body, headers
     end
@@ -48,6 +64,13 @@ module Iterable
       transmit http
     end
 
+    sig do
+      params(
+        verb: Symbol,
+        body: Hash,
+        headers: Hash
+      ).returns(Net::HTTPRequest)
+    end
     private def connection(verb, body = {}, headers = {})
       conn_headers = DEFAULT_HEADERS.dup.merge(headers)
       conn_headers['Api-Key'] = @config.token if @config.token
@@ -56,6 +79,11 @@ module Iterable
       req
     end
 
+    sig do
+      params(
+        http: T.any(Net::HTTP, Net::HTTP::Post, Net::HTTP::Get, Net::HTTP::Put, Net::HTTP::Patch, Net::HTTP::Delete)
+      ).void
+    end
     private def setup_http(http)
       DEFAULT_OPTIONS.dup.each do |option, value|
         setter = "#{option.to_sym}="
@@ -74,6 +102,7 @@ module Iterable
       Net::HTTP.new(@uri.hostname, @uri.port, nil, nil, nil, nil)
     end
 
+    sig { params(req: Net::HTTPRequest).returns(Iterable::Response) }
     private def transmit(req)
       response = nil
       @net.start do |http|
@@ -82,6 +111,7 @@ module Iterable
       handle_response response
     end
 
+    sig { params(response: Net::HTTPResponse).returns(Iterable::Response) }
     private def handle_response(response)
       redirected = response.is_a?(Net::HTTPRedirection) || response.code == '303'
       if redirected && response['location']
@@ -91,6 +121,7 @@ module Iterable
       end
     end
 
+    sig { params(response: Net::HTTPResponse).returns(URI) }
     private def uri_for_redirect(response)
       uri = @config.uri
       redirect_uri = URI(response['location'])

data/lib/iterable/response.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'forwardable'
 
 module Iterable
@@ -6,12 +8,18 @@ module Iterable
   # Response class is used to get access to raw HTTP request info
   class Response
     extend Forwardable
+    extend T::Sig
 
     def_delegators :@resp, :code, :message, :uri, :[]
 
     attr_reader :body
 
     # @!visibility private
+    sig do
+      params(
+        resp: Net::HTTPResponse
+      ).void
+    end
     def initialize(resp)
       @resp = resp
       @body = parsed_body
@@ -19,8 +27,9 @@ module Iterable
 
     ##
     #
-    # Convenience method to determine if request was successfull or not
+    # Convenience method to determine if request was successful or not
     # @return [Boolean]
+    sig { returns(T::Boolean) }
     def success?
       case @resp.code.to_i
       when (200..299) then true
@@ -34,9 +43,14 @@ module Iterable
     # if unable to parse.
     #
     # @return [Hash,Array,String] A parsed JSON object or the original response body
+    sig do
+      returns(
+        T.nilable(T.any(Hash, Array, String))
+      )
+    end
     private def parsed_body
       response_body = @resp.body
-      MultiJson.load response_body
+      MultiJson.load(response_body)
     rescue MultiJson::ParseError
       response_body
     end

data/lib/iterable/templates.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -22,13 +24,35 @@ module Iterable
 
     ##
     #
+    #
     # Get all templates
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        params: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, Integer, String, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def all(params = {})
       Iterable.request(conf, '/templates', params).get
     end
 
+    ##
+    #
+    #
+    # Get a template by client template ID
+    #
+    # @param client_template_id [String|Integer] The client template ID to find by
+    #
+    # @return [Iterable::Response] A response object
+    sig do
+      params(
+        client_template_id: T.any(String, Integer)
+      ).returns(Iterable::Response)
+    end
     def for_client_template_id(client_template_id)
       params = { clientTemplateId: client_template_id }
       Iterable.request(conf, '/templates/getByClientTemplateId', params).get