iterable-api-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d04be11184926b2bcffba1f777270fc08fbf83e676babb5c1e79756e33915464
-  data.tar.gz: 07723ae603767edd511e37a3c682f0348e6a9262ca435e881fd4d86a7e77b515
+  metadata.gz: 003ee817aaa95dc181bf7b36909387689f70ffa1ed755878eb7132a0166b0130
+  data.tar.gz: 3ab136966f544fc25f2431d39a99ac84e94cf5f88c1d496f1dd7b4bd2e45cff2
 SHA512:
-  metadata.gz: dc7f30727eaa45240f3a0f683e58128184397a305214e29e719ae34d0794ee04421bfb0bf496865a285f85edede66691d40e3f0e19a24652261efe38e1b6fa82
-  data.tar.gz: a90443045373add4a10ffd3ddbfb74114e71102b6be4f9f8392af1b179a02813e9432d15c3d743499ccb7ae27a8fcbb2e548fb43ec826aff3e1b4211b29a4e27
+  metadata.gz: d3696c057360e661ee4f632182323a9d99a8af4110be64fce1d1dfd58980c9a13d65dc1b0767df53f17502925526949e1fc17aadc980a4b654479a34a65009bc
+  data.tar.gz: 874f5d7201a038ddc54437e1d0920b3c0bf77f5d5333c5ccdcd5a756e20154d0942b0920c800669e2adb8ef0d3f65a62b66644a936ed25800bf59d26bd571a93

data/README.md

@@ -124,6 +124,7 @@ reponse.uri
   - [Upsert](#email-templates-upsert)
 - [Events](#events)
   - [For Email](#events-for-email)
+  - [Bulk Track](#events-track-bulk)
   - [Track](#events-track)
   - [Track Push Open](#events-track-push-open)
 - [Experiments](#experiments)
@@ -133,6 +134,8 @@ reponse.uri
   - [CSV](#export-csv)
 - [In App](#in-app)
   - [Messages](#in-app-messages)
+  - [Target](#in-app-target)
+  - [Cancel](#in-app-cancel)
 - [Lists](#lists)
   - [All](#lists-all)
   - [Create](#lists-create)
@@ -149,6 +152,9 @@ reponse.uri
   - [Get Key](#metadata-get-key)
   - [Remove Key](#metadata-remove-key)
   - [Add Key](#metadata-add-key)
+- [Push](#push)
+  - [Target](#push-target)
+  - [Cancel](#push-cancel)
 - [Push Templates](#push-templates)
   - [Get](#push-templates-get)
   - [Update](#push-templates-update)
@@ -300,7 +306,8 @@ Endpoint: `GET /catalogs/{catalogName}/fieldMappings`
 ```ruby
 catalog = 'my-catalog'
 catalog_field_mappings = Iterable::CatalogFieldMappings.new(catalog)
-response = catalog_field_mappings.field_mappings
+response = catalog_field_mappings.get
+response.body['params']['definedMappings']
 ```
 
 #### Catalog Field Mappings Update
@@ -557,6 +564,19 @@ attrs = { campaignId: 42, dataFields: {} }
 response = events.track 'event-name', 'user@example.com', attrs
 ```
 
+#### Events Track Bulk
+
+Endpoint: `POST /events/trackBulk`
+
+```ruby
+events = Iterable::Events.new
+# Array of events to track
+events_attrs = [
+  { email: 'user@example.com', eventName: 'event-name', campaignId: 42, dataFields: {} }
+]
+response = iterable_events.track_bulk events_attrs
+```
+
 #### Events Track Push Open
 
 Endpoint: `GET /events/{email}`
@@ -639,7 +659,34 @@ response = in_app.messages_for_user_id 42, count: 2
 # Pass in query parameters
 email = 'user@example.com'
 attrs = { 'platform' => 'iOS' }
-response = in_app.messages_for_email: email, attrs
+response = in_app.messages_for_email email, attrs
+```
+
+#### In App Target
+
+Endpoint: `POST /inApp/target`
+
+```ruby
+in_app = Iterable::InApp.new
+
+# Needs campaign ID and an optional email
+email = 'user@example.com'
+attrs = { 'campaignId' => '123456asdf' }
+response = in_app.target attrs: attrs, email: email
+```
+
+#### In App Cancel
+
+Endpoint: `POST /push/cancel`
+
+```ruby
+in_app = Iterable::InApp.new
+
+# Needs campaign ID and an optional email and optional attrs for request
+email = 'user@example.com'
+campaign_id = '12345asdf'
+attrs = {}
+response = in_app.target campaign_id: campaign_id, attrs: attrs, email: email
 ```
 
 ### Lists
@@ -776,6 +823,32 @@ value = { foo: 'bar', data: 'stuffs' }
 response = metadata_table.add 'metadata-key', value
 ```
 
+### Push
+
+#### Push Target
+
+Endpoint: `POST /push/target`
+
+```ruby
+push = Iterable::Push.new
+campaign_id = '1234asdf'
+email = 'user@example.com' # optional
+attrs = {} # optional extra params for the request
+response = push.target campaign_id: campaign_id, email: email, attrs: attrs
+```
+
+#### Push Cancel
+
+Endpoint: `POST /push/cancel`
+
+```ruby
+push = Iterable::Push.new
+campaign_id = '1234asdf'
+email = 'user@example.com' # optional
+attrs = {} # optional extra params for the request
+response = push.cancel email: email, campaign_id: campaign_id, attrs: attrs
+```
+
 ### Push Templates
 
 #### Push Templates Get
@@ -854,10 +927,10 @@ Endpoint: `POST /users/bulkUpdate`
 users = Iterable::Users.new
 # Array of users to update by email with additional
 # fields if needed
-users = [
+users_attrs = [
 	{ email: 'user@example.com', userID: 'custom-id' }
 ]
-response = users.bulk_update users
+response = users.bulk_update users_attrs
 ```
 
 #### Users Update Subscriptions

data/lib/iterable/events.rb

@@ -39,6 +39,19 @@ module Iterable
       Iterable.request(conf, '/events/track').post(attrs)
     end
 
+    ##
+    #
+    # Bulk Track events
+    #
+    # @param events [Array[Hash]] Array of hashes of event details
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note Event fields can be eventName [String], email [String], dataFields [Hash], or userId [String]
+    def track_bulk(events = [])
+      Iterable.request(conf, '/events/trackBulk').post(events: events)
+    end
+
     ##
     #
     # Track an event

data/lib/iterable/in_app.rb

@@ -41,6 +41,42 @@ module Iterable
       messages(attrs)
     end
 
+    ##
+    #
+    # 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
+    #
+    # @return [Iterable::Response] A response object
+    #
+    def target(campaign_id:, attrs: {}, email: nil)
+      attrs['recipientEmail'] = email if email
+      attrs['campaignId'] = campaign_id
+      Iterable.request(conf, '/inApp/target').post(attrs)
+    end
+
+    ##
+    #
+    # Cancel an In App notification sent to a specific user
+    # 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 attrs [Hash] Additional data to update or add
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note An email or UserId is required
+    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)
       Iterable.request(conf, '/inApp/getMessages', attrs).get
     end

data/lib/iterable/push.rb

@@ -0,0 +1,46 @@
+module Iterable
+  ##
+  #
+  # Interact with /push API endpoints
+  #
+  # @example Creating push endpoint object
+  #   # With default config
+  #   templates = Iterable::Push.new
+  #   templates.target campaign_id: '12345'
+  #
+  class Push < ApiResource
+    ##
+    #
+    # 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 attrs [Hash] Additional data to update or add
+    #
+    # @return [Iterable::Response] A response object
+    def target(campaign_id:, email: nil, attrs: {})
+      attrs['recipientEmail'] = email if email
+      attrs['campaignId'] = campaign_id
+      Iterable.request(conf, '/push/target').post(attrs)
+    end
+
+    ##
+    #
+    # Cancel a push notification to a specific user
+    # 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 attrs [Hash] Additional data to update or add
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @note An email or UserId is required
+    def cancel(email: nil, campaign_id: nil, attrs: {})
+      attrs['email'] = email if email
+      attrs['campaignId'] = campaign_id if campaign_id
+      Iterable.request(conf, '/push/cancel').post(attrs)
+    end
+  end
+end

data/lib/iterable.rb

@@ -22,6 +22,7 @@ files = %w[
   templates
   email_templates
   push_templates
+  push
   users
   workflows
   metadata

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: iterable-api-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chavez
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   skirV2p91csPqqACuQCX2oK9r29QZtt95aAnVdsdBMA+evI2nVknO0OhYDqNA0wR
   SkUCdTSDgV9CsbN/vy6DeR0eX1kP6OrntZJjKnrncbkKZnrJ5fjzKtUyj3I=
   -----END CERTIFICATE-----
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -219,6 +219,20 @@ dependencies:
     - - "~>"
       - !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
@@ -308,6 +322,7 @@ files:
 - lib/iterable/message_types.rb
 - lib/iterable/metadata.rb
 - lib/iterable/metadata_table.rb
+- lib/iterable/push.rb
 - lib/iterable/push_templates.rb
 - lib/iterable/request.rb
 - lib/iterable/response.rb
@@ -320,7 +335,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 - "--main=README.md"
@@ -337,8 +352,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Iterable REST API Client
 test_files: []