iterable-api-client 0.5.1 → 0.6.2

data/lib/iterable/users.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -21,6 +23,15 @@ module Iterable
     # @param attrs [Hash] Additional data to update or add
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def update(email, attrs = {})
       attrs['email'] = email
       Iterable.request(conf, '/users/update').post(attrs)
@@ -36,6 +47,16 @@ module Iterable
     # @return [Iterable::Response] A response object
     #
     # @note User fields can be email [String], dataFields [Hash], or userId [String]
+    sig do
+      params(
+        users: T::Array[
+          T::Hash[
+            T.any(Symbol, String),
+            T.any(T::Boolean, String, Integer, Float, Hash)
+          ]
+        ]
+      ).returns(Iterable::Response)
+    end
     def bulk_update(users = [])
       Iterable.request(conf, '/users/bulkUpdate').post(users: users)
     end
@@ -49,6 +70,15 @@ module Iterable
     # @param attrs [Hash] Additional data to update
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float)
+        ]
+      ).returns(Iterable::Response)
+    end
     def update_subscriptions(email, attrs = {})
       attrs['email'] = email
       Iterable.request(conf, '/users/updateSubscriptions').post(attrs)
@@ -65,6 +95,16 @@ module Iterable
     #
     # @note Refer to [Iterable::Users#update_subscriptions] for what subscription
     # information is needed such as email
+    sig do
+      params(
+        subscriptions: T::Array[
+          T::Hash[
+            T.any(Symbol, String),
+            T.any(T::Boolean, String, Integer, Float, Hash)
+          ]
+        ]
+      ).returns(Iterable::Response)
+    end
     def bulk_update_subscriptions(subscriptions = [])
       attrs = { updateSubscriptionsRequests: subscriptions }
       Iterable.request(conf, '/users/bulkUpdateSubscriptions').post(attrs)
@@ -77,6 +117,7 @@ module Iterable
     # @param email [String] The email of the user to get
     #
     # @return [Iterable::Response] A response object
+    sig { params(email: String).returns(Iterable::Response) }
     def for_email(email)
       Iterable.request(conf, "/users/#{email}").get
     end
@@ -88,6 +129,12 @@ module Iterable
     # @param email [String] The email of the user to get
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        new_email: String
+      ).returns(Iterable::Response)
+    end
     def update_email(email, new_email)
       attrs = { currentEmail: email, newEmail: new_email }
       Iterable.request(conf, '/users/updateEmail').post(attrs)
@@ -100,6 +147,7 @@ module Iterable
     # @param email [String] The email of the user to delete
     #
     # @return [Iterable::Response] A response object
+    sig { params(email: String).returns(Iterable::Response) }
     def delete(email)
       Iterable.request(conf, "/users/#{email}").delete
     end
@@ -111,6 +159,7 @@ module Iterable
     # @param user_id [String] The userId of the user to delete
     #
     # @return [Iterable::Response] A response object
+    sig { params(user_id: T.any(String, Integer)).returns(Iterable::Response) }
     def delete_by_id(user_id)
       Iterable.request(conf, "/users/byUserId/#{user_id}").delete
     end
@@ -122,6 +171,7 @@ module Iterable
     # @param user_id [String] The user ID of the user to get
     #
     # @return [Iterable::Response] A response object
+    sig { params(user_id: T.any(String, Integer)).returns(Iterable::Response) }
     def for_id(user_id)
       Iterable.request(conf, "/users/byUserId/#{user_id}").get
     end
@@ -131,6 +181,7 @@ module Iterable
     # Get the user fields with mappings from field to type
     #
     # @return [Iterable::Response] A response object
+    sig { returns(Iterable::Response) }
     def fields
       Iterable.request(conf, '/users/getFields').get
     end
@@ -146,6 +197,16 @@ module Iterable
     # @return [Iterable::Response] A response object
     #
     # @note An email or userId is required
+    sig do
+      params(
+        email: String,
+        token: String,
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float, Hash)
+        ]
+      ).returns(Iterable::Response)
+    end
     def register_browser_token(email, token, attrs = {})
       attrs[:email] = email
       attrs[:browserToken] = token
@@ -163,6 +224,13 @@ module Iterable
     # @return [Iterable::Response] A response object
     #
     # @note An email or userId is required
+    sig do
+      params(
+        token: String,
+        email: T.nilable(String),
+        user_id: T.nilable(T.any(String, Integer))
+      ).returns(Iterable::Response)
+    end
     def disable_device(token, email = nil, user_id = nil)
       attrs = { token: token }
       attrs[:email] = email if email
@@ -180,6 +248,17 @@ module Iterable
     # @param params [Hash] Additional params to use to filter messages further
     #
     # @return [Iterable::Response] A response object
+    sig do
+      params(
+        email: String,
+        start_time: T.nilable(T.any(Time, Date)),
+        end_time: T.nilable(T.any(Time, Date)),
+        params: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float, Hash)
+        ]
+      ).returns(Iterable::Response)
+    end
     def sent_messages(email, start_time = nil, end_time = nil, params = {})
       params[:email] = email
       params[:startTime] = start_time.to_s if start_time
@@ -195,6 +274,7 @@ module Iterable
     # @param email [String] User email to forget
     #
     # @return [Iterable::Response] A response object
+    sig { params(email: String).returns(Iterable::Response) }
     def forget(email)
       attrs = { email: email }
       Iterable.request(conf, '/users/forget').post(attrs)

data/lib/iterable/workflows.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Iterable
   ##
   #
@@ -22,6 +24,15 @@ module Iterable
     # @return [Iterable::Response] A response object
     #
     # @note An email or listId is required to trigger a workflow
+    sig do
+      params(
+        workflow_id: T.any(String, Integer),
+        attrs: T::Hash[
+          T.any(Symbol, String),
+          T.any(T::Boolean, String, Integer, Float, Hash)
+        ]
+      ).returns(Iterable::Response)
+    end
     def trigger(workflow_id, attrs = {})
       attrs['workflowId'] = workflow_id
       Iterable.request(conf, '/workflows/triggerWorkflow').post(attrs)

data/lib/iterable-api-client.rb

@@ -1 +1,6 @@
-require_relative './iterable' # rubocop:disable Style/FileName
+# rubocop:disable Naming/FileName
+# typed: strict
+
+require_relative 'iterable'
+
+# rubocop:enable Naming/FileName

data/lib/iterable.rb

@@ -1,6 +1,9 @@
+# typed: true
+
 require 'json'
 require 'net/http'
 require 'uri'
+require 'sorbet-runtime'
 
 require 'multi_json'
 
@@ -42,6 +45,8 @@ files.each { |path| require_relative "./iterable/#{path}" }
 #
 # Iterable module for API interactions
 module Iterable
+  extend T::Sig
+
   DATE_FORMAT = '%Y-%m-%d'.freeze
 
   ##
@@ -53,6 +58,7 @@ module Iterable
   #   Iterable.configure do |conf|
   #     conf.token = 'secret-token'
   #   end
+  sig { params(block: T.proc.params(arg0: T.untyped).void).returns(Iterable::Config) }
   module_function def configure(&block)
     config.tap(&block)
   end
@@ -60,12 +66,20 @@ module Iterable
   ##
   #
   # @return [Iterable::Config] The default config for API endpoints
+  sig { returns(Iterable::Config) }
   module_function def config
     @config ||= Config.new
   end
 
   # @!visibility private
+  sig do
+    params(
+      conf: Iterable::Config,
+      path: String,
+      params: Hash
+    ).returns(Iterable::Request)
+  end
   module_function def request(conf, path, params = {})
-    Request.new conf, path, params
+    T.let(Request.new(conf, path, params), Iterable::Request)
   end
 end

data/lib/iterable_api_client.rb

@@ -1 +1,3 @@
-require_relative './iterable'
+# typed: strict
+
+require_relative 'iterable'

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: iterable-api-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Chavez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,260 +35,36 @@ cert_chain:
   JWT1CLPse7JUSW9NGp9hbZqX+FdmVho8u3BpQwtAvZB2dIiRLcaqEqxBRnt4jHCq
   vGIdgu0GJEzPUTqCcDfDQUuNIvjN04ZHfnA5Q3m/I6jypQHs9LNqpo1BQzk=
   -----END CERTIFICATE-----
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.12.0
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.1
-- !ruby/object:Gem::Dependency
-  name: gemcutter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.29.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.29.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.13.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.13.3
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.3
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.14.0
-  type: :development
+        version: 1.15.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '0'
 description: Ruby gem for the Iterable REST API
 email: contact@el-chavez.me
 executables: []
@@ -298,6 +74,7 @@ extra_rdoc_files:
 files:
 - README.md
 - bin/console
+- bin/tapioca
 - lib/iterable-api-client.rb
 - lib/iterable.rb
 - lib/iterable/api_resource.rb
@@ -335,7 +112,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 - "--main=README.md"
@@ -345,15 +122,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Iterable REST API Client
 test_files: []