iterable-api-client 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec75eb2ce6297758dd87c44acd79435578c29bb16f23402d133c2e24d1f6820
-  data.tar.gz: 45658c86e6448f1e75948fa150de1bb6133dacefb3d237cf1edc5504ee90591b
+  metadata.gz: 9b0390e984dea2a8340da13d59a741e7a6316faa65814f767a4cedafbd76e325
+  data.tar.gz: b4b77e7b0767da2e23ad8c3f0a81458897123c30063282092aba897ddc01fd6e
 SHA512:
-  metadata.gz: 9dc86fb5a431fddc281eefb86e0ed597b535dad112e03ef53de5027dd723015d8f1ac791d1ba93c1086aef2cd382d619dafaca348147ada3e7d091ed30afc353
-  data.tar.gz: 8428f4dfd4bec851b1ed30ee7161dfa7f26848f4c210046fb29f8485a002a06c016473366774720f79855179b27f3e8f57793dfcb3203db82956dcef4d50cfd4
+  metadata.gz: 4621a4e84456e759f44eee8a49e46ea7903f97ad64e4f4bf7b1d692c9e703d27b5f81204b02f0f810f2c20acee09559bcdcc7baffb7bb22cba329681685c627d
+  data.tar.gz: 1b32513fe776e416344624cd51008a35e02acd67cbe944b4c0f11fe22354e29cc1adca5af5122791b5e459d853aea74a65b2ca4dfb65bbf74549454bb945450e

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tapioca', 'tapioca')

data/lib/iterable/api_resource.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -6,6 +8,8 @@ module Iterable
   # set per request if needed, otherwise the default global
   # Iterable.config is used
   class ApiResource
+    extend T::Sig
+
     attr_reader :conf
 
     ##
@@ -14,6 +18,7 @@ module Iterable
     # the global [Iterable::Config] via `Iterable.config`
     #
     # @return [Iterable::ApiResource]
+    sig { params(conf: T.nilable(Iterable::Config)).void }
     def initialize(conf = nil)
       @conf = conf || default_config
     end
@@ -23,6 +28,7 @@ module Iterable
     # Global Iterable config accessor for class
     #
     # @return [Iterable::Config]
+    sig { returns(Iterable::Config) }
     def self.default_config
       Iterable.config
     end
@@ -32,6 +38,7 @@ module Iterable
     # Global Iterable config accessor for instance
     #
     # @return [Iterable::Config]
+    sig { returns(Iterable::Config) }
     def default_config
       self.class.default_config
     end

data/lib/iterable/bulk_catalog_items.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -20,10 +22,10 @@ module Iterable
     # Initialize CatalogItems with a catalog name and item ID **currently in Beta only**
     #
     # @param catalog [String] The name of the catalog to interact with
-    # @param item_id [String] The string ID of the item to interact with
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Catalog]
+    sig { params(catalog: String, conf: T.nilable(Iterable::Config)).void }
     def initialize(catalog, conf = nil)
       @catalog = catalog
       super conf
@@ -33,9 +35,10 @@ module Iterable
     #
     # Bulk delete catalog items
     #
-    # @param keys [Array] Array of catalog items ids to delete
+    # @param item_ids [Array] Array of catalog items ids to delete
     #
     # @return [Iterable::Response] A response object
+    sig { params(item_ids: Array).returns(Iterable::Response) }
     def delete(item_ids = [])
       body = { itemIds: item_ids }
       Iterable.request(conf, base_path).delete(body)
@@ -45,11 +48,17 @@ module Iterable
     #
     # Bulk create catalog items
     #
-    # @param documents [Hash] Hash of item ID to item attributes e.g. { '123456': { name: 'foo', state: 'open' } }
+    # @param items [Hash] Hash of item ID to item attributes e.g. { '123456': { name: 'foo', state: 'open' } }
     # @param replace_uploaded_fields_only [Boolean] Whether to replace only the upload fields within each document,
     #                                               not each entire document. Defaults to false and will replace
     #                                               existing.
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        items: Hash,
+        replace_uploaded_fields_only: T::Boolean
+      ).returns(Iterable::Response)
+    end
     def create(items = {}, replace_uploaded_fields_only: false)
       body = {
         documents: items,
@@ -58,6 +67,7 @@ module Iterable
       Iterable.request(conf, base_path).post(body)
     end
 
+    sig { returns(String) }
     private def base_path
       "/catalogs/#{@catalog}/items"
     end

data/lib/iterable/campaigns.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -17,6 +19,7 @@ module Iterable
     # Get all campaigns
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def all
       Iterable.request(conf, '/campaigns').get
     end
@@ -31,6 +34,14 @@ module Iterable
     # @param attrs [Hash] Any other campaign attributes to set
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        name: String,
+        template_id: Integer,
+        list_ids: Array,
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def create(name, template_id, list_ids = [], attrs = {})
       body = attrs.merge(name: name, templateId: template_id, listIds: list_ids)
       Iterable.request(conf, '/campaigns/create').post(body)
@@ -43,6 +54,7 @@ module Iterable
     # @param campaign_id [Integer] Root campaign ID to get child recurring campaigns for
     #
     # @return [Iterable::Response] A response object
+    sig { params(campaign_id: Integer).returns(Iterable::Response) }
     def recurring(campaign_id)
       Iterable.request(conf, "/campaigns/recurring/#{campaign_id}/childCampaigns").get
     end
@@ -51,17 +63,22 @@ module Iterable
     #
     # Export metrics in CSV format for one or more campaigns
     #
-    # @param name [Array] An array of campaign ids, must have at least one
+    # @param campaign_ids [Array] An array of campaign ids, must have at least one
     # @param start_time [Date|Time] Start of metrics to query for
     # @param end_time [Date|Time] End of metrics to query for
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        campaign_ids: Array,
+        start_time: T.nilable(T.any(Date, Time)),
+        end_time: T.nilable(T.any(Date, Time))
+      ).returns(Iterable::Response)
+    end
     def metrics(campaign_ids = [], start_time = nil, end_time = nil)
       params = { campaignId: campaign_ids }
-      if start_time
-        params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT)
-        params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT)
-      end
+      params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT) if start_time
+      params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT) if end_time
       Iterable.request(conf, '/campaigns/metrics', params).get
     end
   end

data/lib/iterable/catalog_field_mappings.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -13,6 +15,8 @@ module Iterable
   #   conf = Iterable::Config.new(token: 'new-token')
   #   catalog = Iterable::CatalogFieldMappings.new("catalog-name", config)
   class CatalogFieldMappings < ApiResource
+    extend T::Sig
+
     attr_reader :catalog
 
     ##
@@ -23,6 +27,7 @@ module Iterable
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Catalog]
+    sig { params(catalog: String, conf: T.any(Iterable::Config, NilClass)).void }
     def initialize(catalog, conf = nil)
       @catalog = catalog
       super conf
@@ -33,6 +38,7 @@ module Iterable
     # Get field mappings for a catalog
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def get
       Iterable.request(conf, base_path).get
     end
@@ -41,7 +47,8 @@ module Iterable
     #
     # Set a catalog's field mappings (data types)
     #
-    # @param [Array] Array of field mapping hashes e.g [{"fieldName":"exampleString","fieldType":"string"}]}
+    # @param mappings_updates [Array] Array of field mapping hashes
+    #  e.g [{"fieldName":"exampleString","fieldType":"string"}]}
     #
     # @return [Iterable::Response] A response object
     #
@@ -50,11 +57,13 @@ module Iterable
     #   field_mappings = [{fieldName: 'test-field', fieldType: 'string'}]
     #   catalog = Iterable::CatalogFieldMappings.new "catalog-name"
     #   catalog.update_field_mappings(field_mappings)
+    sig { params(mappings_updates: Array).returns(Iterable::Response) }
     def update(mappings_updates = [])
       body = { mappingsUpdates: mappings_updates }
       Iterable.request(conf, base_path).put(body)
     end
 
+    sig { returns(String) }
     private def base_path
       "/catalogs/#{@catalog}/fieldMappings"
     end

data/lib/iterable/catalog_items.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -24,6 +26,13 @@ module Iterable
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Catalog]
+    sig do
+      params(
+        catalog: String,
+        item_id: T.nilable(String),
+        conf: T.nilable(Iterable::Config)
+      ).void
+    end
     def initialize(catalog, item_id = nil, conf = nil)
       @catalog = catalog
       @item_id = item_id
@@ -37,6 +46,7 @@ module Iterable
     # @param params[Hash] Attribute hash for item query (page, pageSize, orderBy, sortAscending)
     #
     # @return [Iterable::Response] A response object
+    sig { params(params: Hash).returns(Iterable::Response) }
     def all(params = {})
       Iterable.request(conf, base_path, params).get
     end
@@ -48,6 +58,7 @@ module Iterable
     # @param item_attrs [Hash] Item attributes to save or replace with
     #
     # @return [Iterable::Response] A response object
+    sig { params(item_attrs: Hash).returns(Iterable::Response) }
     def create(item_attrs = {})
       body = { value: item_attrs }
       Iterable.request(conf, base_path).put(body)
@@ -61,6 +72,7 @@ module Iterable
     # @param item_attrs [Hash] Item attributes to save or update with
     #
     # @return [Iterable::Response] A response object
+    sig { params(item_attrs: Hash).returns(Iterable::Response) }
     def update(item_attrs = {})
       body = { update: item_attrs }
       Iterable.request(conf, base_path).patch(body)
@@ -71,6 +83,7 @@ module Iterable
     # Get a specific catalog item
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def get
       Iterable.request(conf, base_path).get
     end
@@ -80,10 +93,12 @@ module Iterable
     # Delete a catalog item
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def delete
       Iterable.request(conf, base_path).delete
     end
 
+    sig { returns(String) }
     private def base_path
       path = "/catalogs/#{@catalog}/items"
       path += "/#{@item_id}" if @item_id

data/lib/iterable/catalogs.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -23,6 +25,7 @@ module Iterable
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Catalog]
+    sig { params(name: String, conf: T.nilable(Iterable::Config)).void }
     def initialize(name, conf = nil)
       @name = name
       super conf
@@ -33,6 +36,7 @@ module Iterable
     # Create a catalog
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def create
       Iterable.request(conf, base_path).post
     end
@@ -42,6 +46,7 @@ module Iterable
     # Delete a catalog
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def delete
       Iterable.request(conf, base_path).delete
     end
@@ -51,10 +56,12 @@ module Iterable
     # Get a list of all catalog names
     #
     # @return [Iterable::Response] A response object
+    sig { params(params: Hash).returns(Iterable::Response) }
     def names(params = {})
       Iterable.request(conf, '/catalogs', params).get
     end
 
+    sig { returns(String) }
     private def base_path
       "/catalogs/#{@name}"
     end

data/lib/iterable/channels.rb

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

data/lib/iterable/commerce.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -23,6 +25,14 @@ module Iterable
     # @param attrs [Hash] Track purchase request additional fields
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        total: T.any(String, Float),
+        items: T::Array[Hash],
+        user: Hash,
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def track_purchase(total, items = [], user = {}, attrs = {})
       data = {
         total: total,
@@ -42,6 +52,12 @@ module Iterable
     # @param items [Array[Hash]] Array of hashes of commerce items
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        user: Hash,
+        items: T::Array[Hash]
+      ).returns(Iterable::Response)
+    end
     def update_cart(user = {}, items = [])
       data = {
         items: items,

data/lib/iterable/config.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   # Config provides a class to configre the API calls when interacting with
@@ -6,6 +8,8 @@ module Iterable
   # @example Creating a config object
   #   Iterable::Config.new token: 'secret-token'
   class Config
+    extend T::Sig
+
     DEFAULT_VERSION = '1.8'.freeze
     DEFAULT_HOST = 'https://api.iterable.com'.freeze
     DEFAULT_URI = "#{DEFAULT_HOST}/api".freeze
@@ -20,6 +24,7 @@ module Iterable
     #
     # @param token [String] Iterable API token
     # @return [Iterable::Config]
+    sig { params(token: T.nilable(String)).void }
     def initialize(token: nil)
       @host = DEFAULT_HOST
       @port = DEFAULT_PORT
@@ -32,6 +37,7 @@ module Iterable
     # Creates a [URI] for the API host
     #
     # @return [URI] API URI object
+    sig { returns(URI) }
     def uri
       URI.parse("#{@host || DEFAULT_HOST}:#{@port || DEFAULT_PORT}/api")
     end

data/lib/iterable/csv_exporter.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -12,6 +14,7 @@ module Iterable
   #   conf = Iterable::Config.new(token: 'new-token')
   #   exporter = Iterable::CsvExporter.new(Iterable::Export::EMAIL_SEND_TYPE, nil, nil, nil, config)
   class CsvExporter < Export
+    sig { override.returns(String) }
     def format
       'csv'
     end

data/lib/iterable/device.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -31,6 +33,15 @@ module Iterable
     # @param conf [Iterable::Config] A config to optionally pass for requests
     #
     # @return [Iterable::Device]
+    sig do
+      params(
+        token: String,
+        app: String,
+        platform: String,
+        data_fields: Hash,
+        conf: T.nilable(Iterable::Config)
+      ).void
+    end
     def initialize(token, app, platform, data_fields = {}, conf = nil)
       @token = token
       @app = app
@@ -47,6 +58,7 @@ module Iterable
     # @param user_id [String] User ID to associate device with instead of email
     #
     # @return [Iterable::Response] A response object
+    sig { params(email: String, user_id: T.nilable(String)).returns(Iterable::Response) }
     def register(email, user_id = nil)
       attrs = {
         device: device_data
@@ -56,10 +68,12 @@ module Iterable
       Iterable.request(conf, base_path).post(attrs)
     end
 
+    sig { returns(String) }
     private def base_path
       '/users/registerDeviceToken'
     end
 
+    sig { returns(Hash) }
     private def device_data
       {
         token: @token,

data/lib/iterable/email.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -18,9 +20,16 @@ module Iterable
     #
     # @param email [String] Email of user who received the message to view
     # @param message_id [String|Integer] Message id for message sent
-    # @param attrs [Hash] Hash of attributes to pass like dataFields with the requst
+    # @param attrs [Hash] Hash of attributes to pass like dataFields with the request
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: T.nilable(String),
+        message_id: T.any(String, Integer),
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def view(email, message_id, attrs = {})
       attrs['email'] = email
       attrs['messageId'] = message_id
@@ -38,6 +47,13 @@ module Iterable
     # @param attrs [Hash] Hash of attributes to pass like dataFields with the request
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        campaign_id: Integer,
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def target(email, campaign_id, attrs = {})
       attrs[:recipientEmail] = email
       attrs[:campaignId] = campaign_id

data/lib/iterable/email_templates.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -20,6 +22,12 @@ 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: Hash
+      ).returns(Iterable::Response)
+    end
     def get(template_id, params = {})
       params['templateId'] = template_id
       Iterable.request(conf, '/templates/email/get', params).get
@@ -33,6 +41,12 @@ module Iterable
     # @param attrs [Hash] Update attributes
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        template_id: T.any(String, Integer),
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def update(template_id, attrs = {})
       attrs['templateId'] = template_id
       Iterable.request(conf, '/templates/email/update').post(attrs)
@@ -46,6 +60,12 @@ module Iterable
     # @param attrs [Hash] Update attributes
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        client_template_id: String,
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def upsert(client_template_id, attrs = {})
       attrs['clientTemplateId'] = client_template_id
       Iterable.request(conf, '/templates/email/upsert').post(attrs)

data/lib/iterable/events.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -20,6 +22,12 @@ module Iterable
     # @param limit [Integer] Limit of events to return, max 200 default 30
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        limit: Integer
+      ).returns(Iterable::Response)
+    end
     def for_email(email, limit = 30)
       Iterable.request(conf, "/events/#{email}", limit: limit).get
     end
@@ -33,6 +41,13 @@ module Iterable
     # @param attrs [Hash] Event values and fields to include
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        name: T.nilable(String),
+        email: T.nilable(String),
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def track(name, email = nil, attrs = {})
       attrs[:eventName] = name
       attrs[:email] = email
@@ -48,6 +63,7 @@ module Iterable
     # @return [Iterable::Response] A response object
     #
     # @note Event fields can be eventName [String], email [String], dataFields [Hash], or userId [String]
+    sig { params(events: T::Array[Hash]).returns(Iterable::Response) }
     def track_bulk(events = [])
       Iterable.request(conf, '/events/trackBulk').post(events: events)
     end
@@ -62,6 +78,14 @@ module Iterable
     # @param attrs [Hash] Event values and fields to include
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        campaign_id: T.any(String, Integer),
+        message_id: T.any(String, Integer),
+        email: T.nilable(String),
+        attrs: Hash
+      ).returns(Iterable::Response)
+    end
     def track_push_open(campaign_id, message_id, email, attrs = {})
       attrs[:campaignId] = campaign_id
       attrs[:messageId] = message_id

data/lib/iterable/experiments.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::Experiments]
+    sig do
+      params(
+        experiment_ids: T::Array[Integer],
+        conf: T.nilable(Iterable::Config)
+      ).void
+    end
     def initialize(experiment_ids = [], conf = nil)
       @experiment_ids = experiment_ids
       super conf
@@ -31,20 +39,25 @@ module Iterable
     #
     # Get metrics for experiments
     #
-    # @params campaign_ids [Array] Array of campaignIds to optionally query for
+    # @param campaign_ids [Array] Array of campaignIds to optionally query for
     # @param start_time [Date|Time] Start of metrics to query for
     # @param end_time [Date|Time] End of metrics to query for
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        campaign_ids: Array,
+        start_time: T.any(Date, Time, NilClass),
+        end_time: T.any(Date, Time, NilClass)
+      ).returns(Iterable::Response)
+    end
     def metrics(campaign_ids = [], start_time = nil, end_time = nil)
       params = {
         experimentId: @experiment_ids,
         campaignId: campaign_ids
       }
-      if start_time
-        params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT)
-        params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT)
-      end
+      params[:startTime] = start_time.to_date.strftime(Iterable::DATE_FORMAT) if start_time
+      params[:endTime] = end_time.to_date.strftime(Iterable::DATE_FORMAT) if end_time
       Iterable.request(conf, '/experiments/metrics', params).get
     end
   end