iterable-api-client 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4506c996979cb9df87929946898bd6c84f7de779be90190965d962a917b9c588
-  data.tar.gz: 9ba69e4096a6eaf62eb243eca90b0369c35d6f2fcbf7728f4a0df89aef911a4d
+  metadata.gz: b456f80ce650910ada263cdb96b28a5fd188dd5afcc4aa44813e0b3892d5d946
+  data.tar.gz: 308c15224339eb8a859cf3d9f6491907595d58da5d8bcc46c3f8223ddd356660
 SHA512:
-  metadata.gz: 4ec86d3bc2f892914c393e8bcc01f84cb533ca32206281dd771123282fe650f48e62394905bf0c32ae0643098cf7a466fe81843c928b83e9b9e711a78fcec97e
-  data.tar.gz: 6e8319780483c79d4f158763832ad8e84776fbd51a0a37a81c2dbb642524799ce2b4096cfdcb3a76d284214e66fb4f1d26ca7c5cacdc6c0f952732aefe9c03b8
+  metadata.gz: 57c4ad6a3f16d3f7ab4b490bedf27b028f24f2ae1c1de9d79815740d3398d04aeffa0b42543de150a1bec6a988f3821f6f970605beb5da9a7a7890e95fcb49a2
+  data.tar.gz: ae76c13bcb47302c41ca6b4a763b6dd53b6669da101b53f927500c73584facd143c0dbbedd922baacfea6806b82f52da84f2c2592f3255d6e7fed580ad152c36

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-~>G���zp+
-��i���-��.���~���C">�S�.q?�M� �������m�5R�����;�p5T'���]@�&d���ps�$�_=Њ�'ƅ��6Ɵ�I?]�mR��om������ݗ����k�.��K_���([xr��\����E���}{zV^F�N8���~UH`oj�L�:md���~�fxph�����!��L���{/�V�!�: P%�� ﾣr��]���
+DR=OII�
H�0>;��>҄$7�5�D��^.���͇�d3��ERl2�)�+F���x��x�p\���G5�x�`��9�c���}m�m����r�jiG�w[b��1���������l��D�t��Y]Z

data/README.md

@@ -1,7 +1,7 @@
 # Iterable API Gem
 
 [![Gem](https://img.shields.io/gem/v/iterable-api-client.svg)](https://rubygems.org/gems/iterable-api-client)
-[![build status](https://gitlab.com/mtchavez/iterable/badges/master/build.svg)](https://gitlab.com/mtchavez/iterable/commits/master)
+[![pipeline status](https://gitlab.com/mtchavez/iterable/badges/master/pipeline.svg)](https://gitlab.com/mtchavez/iterable/-/commits/master)
 [![coverage report](https://gitlab.com/mtchavez/iterable/badges/master/coverage.svg)](https://gitlab.com/mtchavez/iterable/commits/master)
 
 Rubygem to interact with the [Iterable][iterable] API.
@@ -87,73 +87,127 @@ reponse.uri
 
 ## API Endpoints
 
-* [Campaigns](#campaigns)
-  * [All](#campaigns-all)
-  * [Create](#campaigns-create)
-  * [Metrics](#campaigns-metrics)
-  * [Child Campaigns](#campaigns-child)
-* [Channels](#channels)
-  * [All](#channels-all)
-* [Commerce](#commerce)
-  * [Track Purchase](#commerce-track-purchase)
-  * [Update Cart](#commerce-update-cart)
-* [Device](#device)
-  * [Register Device Token](#device-register-token)
-* [Email](#email)
-  * [View](#email-view)
-  * [Target](#email-target)
-* [Email Templates](#email-templates)
-  * [Get](#email-templates-get)
-  * [Update](#email-templates-update)
-  * [Upsert](#email-templates-upsert)
-* [Events](#events)
-  * [For Email](#events-for-email)
-  * [Track](#events-track)
-  * [Track Push Open](#events-track-push-open)
-* [Experiments](#experiments)
-  * [Metrics](#experiments-metrics)
-* [Export](#export)
-  * [JSON](#export-json)
-  * [CSV](#export-csv)
-* [Lists](#lists)
-  * [All](#lists-all)
-  * [Create](#lists-create)
-  * [Delete](#lists-delete)
-  * [Get Users](#lists-users)
-  * [Subscribe](#lists-subscribe)
-  * [Unsubscribe](#lists-unsubscribe)
-* [Message Types](#message-types)
-  * [All](#message-types-all)
-* [Metadata](#metadata)
-  * [Get](#metadata-get)
-  * [List Keys](#metadata-list-keys)
-  * [Delete](#metadata-delete)
-  * [Get Key](#metadata-get-key)
-  * [Remove Key](#metadata-remove-key)
-  * [Add Key](#metadata-add-key)
-* [Push Templates](#push-templates)
-  * [Get](#push-templates-get)
-  * [Update](#push-templates-update)
-  * [Upsert](#push-templates-upsert)
-* [Templates](#templates)
-  * [All](#templates-all)
-  * [Get](#templates-get)
-* [Users](#users)
-  * [Update](#users-update)
-  * [Bulk Update](#users-bulk-update)
-  * [Update Subscriptions](#users-update-subscriptions)
-  * [Bulk Update Subscriptions](#users-bulk-update-subscriptions)
-  * [For Email](#users-for-email)
-  * [By User ID](#users-by-id)
-  * [Get Fields](#users-get-fields)
-  * [Update Email](#users-update-email)
-  * [Delete](#users-delete)
-  * [Delete By ID](#users-delete-by-id)
-  * [Register Browser Token](#users-register-browser-token)
-  * [Disable Device](#users-disable-device)
-  * [Get Sent Messages](#users-get-messages)
-* [Workflows](#workflows)
-  * [Trigger](#workflows-trigger)
+- [Bulk Catalog Items](#bulk-catalog-items)
+  - [Create](#bulk-catalog-items-create)
+  - [Delete](#bulk-catalog-items-delete)
+- [Campaigns](#campaigns)
+  - [All](#campaigns-all)
+  - [Create](#campaigns-create)
+  - [Metrics](#campaigns-metrics)
+  - [Child Campaigns](#campaigns-child)
+- [Catalog Field Mappings](#catalog-field-mappings)
+  - [Get](#catalog-field-mappings-get)
+  - [Update](#catalog-field-mappings-update)
+- [Catalog Items](#catalog-items)
+  - [All](#catalog-items-all)
+  - [Create](#catalog-items-create)
+  - [Update](#catalog-items-update)
+  - [Get](#catalog-items-get)
+  - [Delete](#catalog-items-delete)
+- [Catalogs](#catalogs)
+  - [Create](#catalogs-create)
+  - [Delete](#catalogs-delete)
+  - [Names](#catalogs-names)
+- [Channels](#channels)
+  - [All](#channels-all)
+- [Commerce](#commerce)
+  - [Track Purchase](#commerce-track-purchase)
+  - [Update Cart](#commerce-update-cart)
+- [Device](#device)
+  - [Register Device Token](#device-register-token)
+- [Email](#email)
+  - [View](#email-view)
+  - [Target](#email-target)
+- [Email Templates](#email-templates)
+  - [Get](#email-templates-get)
+  - [Update](#email-templates-update)
+  - [Upsert](#email-templates-upsert)
+- [Events](#events)
+  - [For Email](#events-for-email)
+  - [Track](#events-track)
+  - [Track Push Open](#events-track-push-open)
+- [Experiments](#experiments)
+  - [Metrics](#experiments-metrics)
+- [Export](#export)
+  - [JSON](#export-json)
+  - [CSV](#export-csv)
+- [In App](#in-app)
+  - [Messages](#in-app-messages)
+- [Lists](#lists)
+  - [All](#lists-all)
+  - [Create](#lists-create)
+  - [Delete](#lists-delete)
+  - [Get Users](#lists-users)
+  - [Subscribe](#lists-subscribe)
+  - [Unsubscribe](#lists-unsubscribe)
+- [Message Types](#message-types)
+  - [All](#message-types-all)
+- [Metadata](#metadata)
+  - [Get](#metadata-get)
+  - [List Keys](#metadata-list-keys)
+  - [Delete](#metadata-delete)
+  - [Get Key](#metadata-get-key)
+  - [Remove Key](#metadata-remove-key)
+  - [Add Key](#metadata-add-key)
+- [Push Templates](#push-templates)
+  - [Get](#push-templates-get)
+  - [Update](#push-templates-update)
+  - [Upsert](#push-templates-upsert)
+- [Templates](#templates)
+  - [All](#templates-all)
+  - [Get](#templates-get)
+- [Users](#users)
+  - [Update](#users-update)
+  - [Bulk Update](#users-bulk-update)
+  - [Update Subscriptions](#users-update-subscriptions)
+  - [Bulk Update Subscriptions](#users-bulk-update-subscriptions)
+  - [For Email](#users-for-email)
+  - [By User ID](#users-by-id)
+  - [Get Fields](#users-get-fields)
+  - [Update Email](#users-update-email)
+  - [Delete](#users-delete)
+  - [Delete By ID](#users-delete-by-id)
+  - [Register Browser Token](#users-register-browser-token)
+  - [Disable Device](#users-disable-device)
+  - [Get Sent Messages](#users-get-messages)
+  - [Forget](#users-forget)
+- [Workflows](#workflows)
+  - [Trigger](#workflows-trigger)
+
+### Bulk Catalog Items
+
+**Beta access only** endpoint
+
+#### Bulk Catalog Items Create
+
+Endpoint: `POST /catalogs/{catalogName}/items`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::BulkCatalogItems.new(catalog)
+# Hash of item id to item values
+create_items = {
+  '122343453' => {
+    name: 'item name',
+    status: 'open'
+  }
+}
+response = catalog_items.create(create_items, replace_uploaded_fields_only: true)
+ # Use replace_uploaded_fields_only as true to update fields
+ # of existing items. Otherwise the default is to replace
+ # existing items
+```
+
+#### Bulk Catalog Items Delete
+
+Endpoint: `DELETE /catalogs/{catalogName}/items`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::BulkCatalogItems.new(catalog)
+item_ids = ['12345', '12346', '12347']
+response = catalog_items.create(item_ids)
+```
 
 ### Campaigns
 
@@ -200,6 +254,160 @@ campaigns = Iterable::Campaigns.new
 response = campaigns.recurring 'campaign-id'
 ```
 
+### Catalogs
+
+**Beta access only** endpoint
+
+#### Catalogs Create
+
+Endpoint: `POST /catalogs/{catalogName}`
+
+```ruby
+catalog = 'my-catalog'
+catalogs = Iterable::Catalogs.new(catalog)
+response = catalogs.create
+```
+
+#### Catalogs Delete
+
+Endpoint: `DELETE /catalogs/{catalogName}`
+
+```ruby
+catalog = 'my-catalog'
+catalogs = Iterable::Catalogs.new(catalog)
+response = catalogs.delete
+```
+
+#### Catalogs Names
+
+Endpoint: `GET /catalogs/{catalogName}`
+
+```ruby
+catalog = 'my-catalog'
+catalogs = Iterable::Catalogs.new(catalog)
+params = { page: 1, pageSize: 20 }
+response = catalogs.names(params)
+```
+
+### Catalog Field Mappings
+
+**Beta access only** endpoint
+
+#### Catalog Field Mappings Get
+
+Endpoint: `GET /catalogs/{catalogName}/fieldMappings`
+
+```ruby
+catalog = 'my-catalog'
+catalog_field_mappings = Iterable::CatalogFieldMappings.new(catalog)
+response = catalog_field_mappings.field_mappings
+```
+
+#### Catalog Field Mappings Update
+
+Endpoint: `PUT /catalogs/{catalogName}/fieldMappings`
+
+```ruby
+catalog = 'my-catalog'
+field_mappings = [{fieldName: 'test-field', fieldType: 'string'}]
+catalog_field_mappings = Iterable::CatalogFieldMappings.new(catalog)
+catalog_field_mappings.update(field_mappings)
+```
+
+### Catalog Items
+
+**Beta access only** endpoint
+
+#### Catalog Items All
+
+Endpoint: `GET /catalogs/{catalogName}/items`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::CatalogItems.new(catalog)
+response = catalog_items.all
+```
+
+#### Catalog Items Create
+
+Endpoint: `PUT /catalogs/{catalogName}/items/{itemId}`
+
+```ruby
+catalog = 'my-catalog'
+item_id = '1234-abcd-1234-abcd'
+catalog_items = Iterable::CatalogItems.new(catalog, item_id)
+item_attrs = { name: 'item name', status: 'open' }
+response = catalog_items.create(item_attrs)
+```
+
+#### Catalog Items Update
+
+Endpoint: `PATCH /catalogs/{catalogName}/items/{itemId}`
+
+```ruby
+catalog = 'my-catalog'
+item_id = '1234-abcd-1234-abcd'
+catalog_items = Iterable::CatalogItems.new(catalog, item_id)
+item_attrs = { name: 'item name', status: 'open' }
+response = catalog_items.update(item_attrs)
+```
+
+#### Catalog Items Get
+
+Endpoint: `GET /catalogs/{catalogName}/items/{itemId}`
+
+```ruby
+catalog = 'my-catalog'
+item_id = '1234-abcd-1234-abcd'
+catalog_items = Iterable::CatalogItems.new(catalog, item_id)
+response = catalog_items.get
+```
+
+#### Catalog Items Delete
+
+Endpoint: `DELETE /catalogs/{catalogName}/items/{itemId}`
+
+```ruby
+catalog = 'my-catalog'
+item_id = '1234-abcd-1234-abcd'
+catalog_items = Iterable::CatalogItems.new(catalog, item_id)
+response = catalog_items.delete
+```
+
+### Catalogs
+
+**Beta access only** endpoint
+
+#### Catalogs Create
+
+Endpoint: `POST /catalogs/{catalogName}`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::Catalogs.new(catalog)
+response = catalog_items.create
+```
+
+#### Catalogs Delete
+
+Endpoint: `DELETE /catalogs/{catalogName}`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::Catalogs.new(catalog)
+response = catalog_items.delete
+```
+
+#### Catalogs Names
+
+Endpoint: `GET /catalogs/{catalogName}/names`
+
+```ruby
+catalog = 'my-catalog'
+catalog_items = Iterable::Catalogs.new(catalog)
+params = { page: 1, pageSize: 20 }
+response = catalog_items.names(params)
+```
 
 ### Channels
 
@@ -411,6 +619,29 @@ start_time = end_time - (60 * 60* 24 * 7) # 7 days ago
 response = exporter.export start_time, end_time
 ```
 
+### In App
+
+#### In App Messages
+
+Endpoint: `GET /inApp/getMessages`
+
+```ruby
+in_app = Iterable::InApp.new
+
+# Get messages for a user by email
+email = 'user@example.com'
+response = in_app.messages_for_email email, count: 10
+
+# Get messages for a user by user_id
+email = 'user@example.com'
+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
+```
+
 ### Lists
 
 #### Lists All
@@ -744,6 +975,17 @@ start_time = end_time - (60 * 60* 24 * 7) # 7 days ago
 response = users.sent_messages 'user@example.com', start_time, end_time, params
 ```
 
+#### Users Forget
+
+Endpoint: `POST /users/forget`
+
+```ruby
+users = Iterable::Users.new
+# Additional params to filter and query by
+email = 'user@example.com'
+response = users.forget email
+```
+
 ### Workflows
 
 #### Workflows Trigger

data/lib/iterable/api_resource.rb

@@ -15,7 +15,7 @@ module Iterable
     #
     # @return [Iterable::ApiResource]
     def initialize(conf = nil)
-      @conf = conf ? conf : default_config
+      @conf = conf || default_config
     end
 
     ##

data/lib/iterable/bulk_catalog_items.rb

@@ -0,0 +1,65 @@
+module Iterable
+  ##
+  #
+  # Interact with /catalogs/{catalogName}/items API endpoints
+  # **currently in Beta only**
+  #
+  # @example Creating catalog items endpoint object
+  #   # With default config
+  #   catalog = Iterable::BulkCatalogItems.new "catalog-name"
+  #   catalog.items
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   catalog = Iterable::BulkCatalogItems.new("catalog-name", config)
+  class BulkCatalogItems < ApiResource
+    attr_reader :catalog
+
+    ##
+    #
+    # 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]
+    def initialize(catalog, conf = nil)
+      @catalog = catalog
+      super conf
+    end
+
+    ##
+    #
+    # Bulk delete catalog items
+    #
+    # @param keys [Array] Array of catalog items ids to delete
+    #
+    # @return [Iterable::Response] A response object
+    def delete(item_ids = [])
+      body = { itemIds: item_ids }
+      Iterable.request(conf, base_path).delete(body)
+    end
+
+    ##
+    #
+    # Bulk create catalog items
+    #
+    # @param documents [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
+    def create(items = {}, replace_uploaded_fields_only: false)
+      body = {
+        documents: items,
+        replaceUploadedFieldsOnly: replace_uploaded_fields_only
+      }
+      Iterable.request(conf, base_path).post(body)
+    end
+
+    private def base_path
+      "/catalogs/#{@catalog}/items"
+    end
+  end
+end

data/lib/iterable/catalog_field_mappings.rb

@@ -0,0 +1,61 @@
+module Iterable
+  ##
+  #
+  # Interact with /catalogs/{catalogName}/fieldMappings API endpoints
+  # **currently in Beta only**
+  #
+  # @example Creating catalog field mappings endpoint object
+  #   # With default config
+  #   catalog = Iterable::CatalogFieldMappings.new "catalog-name"
+  #   catalog.items
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   catalog = Iterable::CatalogFieldMappings.new("catalog-name", config)
+  class CatalogFieldMappings < ApiResource
+    attr_reader :catalog
+    ##
+    #
+    # Initialize CatalogFieldMappings with a catalog name **currently in Beta only**
+    #
+    # @param catalog [String] The name of the catalog to interact with
+    # @param conf [Iterable::Config] A config to optionally pass for requests
+    #
+    # @return [Iterable::Catalog]
+    def initialize(catalog, conf = nil)
+      @catalog = catalog
+      super conf
+    end
+
+    ##
+    #
+    # Get field mappings for a catalog
+    #
+    # @return [Iterable::Response] A response object
+    def get
+      Iterable.request(conf, base_path).get
+    end
+
+    ##
+    #
+    # Set a catalog's field mappings (data types)
+    #
+    # @param [Array] Array of field mapping hashes e.g [{"fieldName":"exampleString","fieldType":"string"}]}
+    #
+    # @return [Iterable::Response] A response object
+    #
+    # @example Supplying field mappings
+    #   # Fields to update with field types
+    #   field_mappings = [{fieldName: 'test-field', fieldType: 'string'}]
+    #   catalog = Iterable::CatalogFieldMappings.new "catalog-name"
+    #   catalog.update_field_mappings(field_mappings)
+    def update(mappings_updates = [])
+      body = { mappingsUpdates: mappings_updates }
+      Iterable.request(conf, base_path).put(body)
+    end
+
+    private def base_path
+      "/catalogs/#{@catalog}/fieldMappings"
+    end
+  end
+end

data/lib/iterable/catalog_items.rb

@@ -0,0 +1,93 @@
+module Iterable
+  ##
+  #
+  # Interact with /catalogs/{catalogName}/{itemID} API endpoints
+  # **currently in Beta only**
+  #
+  # @example Creating catalog items endpoint object
+  #   # With default config
+  #   catalog = Iterable::CatalogItems.new "catalog-name"
+  #   catalog.items
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   catalog = Iterable::CatalogItems.new("catalog-name", config)
+  class CatalogItems < ApiResource
+    attr_reader :catalog, :item_id
+
+    ##
+    #
+    # 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]
+    def initialize(catalog, item_id = nil, conf = nil)
+      @catalog = catalog
+      @item_id = item_id
+      super conf
+    end
+
+    ##
+    #
+    # Get all items for a catalog
+    #
+    # @param params[Hash] Attribute hash for item query (page, pageSize, orderBy, sortAscending)
+    #
+    # @return [Iterable::Response] A response object
+    def all(params = {})
+      Iterable.request(conf, base_path, params).get
+    end
+
+    ##
+    #
+    # Create a catalog item
+    #
+    # @param item_attrs [Hash] Item attributes to save or replace with
+    #
+    # @return [Iterable::Response] A response object
+    def create(item_attrs = {})
+      body = { value: item_attrs }
+      Iterable.request(conf, base_path).put(body)
+    end
+    alias replace create
+
+    ##
+    #
+    # Update a catalog item
+    #
+    # @param item_attrs [Hash] Item attributes to save or update with
+    #
+    # @return [Iterable::Response] A response object
+    def update(item_attrs = {})
+      body = { update: item_attrs }
+      Iterable.request(conf, base_path).patch(body)
+    end
+
+    ##
+    #
+    # Get a specific catalog item
+    #
+    # @return [Iterable::Response] A response object
+    def get
+      Iterable.request(conf, base_path).get
+    end
+
+    ##
+    #
+    # Delete a catalog item
+    #
+    # @return [Iterable::Response] A response object
+    def delete
+      Iterable.request(conf, base_path).delete
+    end
+
+    private def base_path
+      path = "/catalogs/#{@catalog}/items"
+      path += "/#{@item_id}" if @item_id
+      path
+    end
+  end
+end

data/lib/iterable/catalogs.rb

@@ -0,0 +1,61 @@
+module Iterable
+  ##
+  #
+  # Interact with /catalogs/{catalogName} API endpoints
+  # **currently in Beta only**
+  #
+  # @example Creating catalog endpoint object
+  #   # With default config
+  #   catalog = Iterable::Catalogs.new "catalog-name"
+  #   catalog.items
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   catalog = Iterable::Catalogs.new("catalog-name", config)
+  class Catalogs < ApiResource
+    attr_reader :name
+    ##
+    #
+    # Initialize Catalogs with a catalog name **currently in Beta only**
+    #
+    # @param name [String] The name of the catalog to interact with
+    # @param conf [Iterable::Config] A config to optionally pass for requests
+    #
+    # @return [Iterable::Catalog]
+    def initialize(name, conf = nil)
+      @name = name
+      super conf
+    end
+
+    ##
+    #
+    # Create a catalog
+    #
+    # @return [Iterable::Response] A response object
+    def create
+      Iterable.request(conf, base_path).post
+    end
+
+    ##
+    #
+    # Delete a catalog
+    #
+    # @return [Iterable::Response] A response object
+    def delete
+      Iterable.request(conf, base_path).delete
+    end
+
+    ##
+    #
+    # Get a list of all catalog names
+    #
+    # @return [Iterable::Response] A response object
+    def names(params = {})
+      Iterable.request(conf, '/catalogs', params).get
+    end
+
+    private def base_path
+      "/catalogs/#{@name}"
+    end
+  end
+end

data/lib/iterable/device.rb

@@ -56,13 +56,11 @@ module Iterable
       Iterable.request(conf, base_path).post(attrs)
     end
 
-    private
-
-    def base_path
+    private def base_path
       '/users/registerDeviceToken'
     end
 
-    def device_data
+    private def device_data
       {
         token: @token,
         applicationName: @app,

data/lib/iterable/export.rb

@@ -103,20 +103,26 @@ module Iterable
       Iterable.request(conf, base_path, request_params(params)).get
     end
 
-    protected
-
-    def base_path
+    protected def base_path
       "/export/data.#{format}"
     end
 
-    def request_params(params = {})
+    protected def request_params(params = {})
       default_params.merge params
     end
 
-    def default_params
+    protected def only_fields?
+      @only_fields&.length.to_i.positive?
+    end
+
+    protected def omit_fields?
+      @omit_fields&.length.to_i.positive?
+    end
+
+    protected def default_params
       params = { dataTypeName: @data_type }
-      params[:onlyFields] = @only_fields if @only_fields && @only_fields.length.positive?
-      params[:omitFields] = @omit_fields.join(',') if @omit_fields && @omit_fields.length.positive?
+      params[:onlyFields] = @only_fields if only_fields?
+      params[:omitFields] = @omit_fields.join(',') if omit_fields?
       params[:campaignId] = @campaign_id if @campaign_id
       params
     end

data/lib/iterable/in_app.rb

@@ -0,0 +1,48 @@
+module Iterable
+  ##
+  #
+  # Interact with /inApp API endpoints
+  #
+  # @example Creating in app endpoint object
+  #   # With default config
+  #   in_app = Iterable::InApp.new
+  #
+  #   # With custom config
+  #   conf = Iterable::Config.new(token: 'new-token')
+  #   in_app = Iterable::InApp.new(config)
+  class InApp < ApiResource
+    ##
+    #
+    # Get in-app messages for a user by email
+    #
+    # @param email [String] *required* Email of user who received the message to view. Required if no user_id present.
+    # @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
+    def messages_for_email(email, count: 1, **attrs)
+      attrs[:email] = email
+      attrs[:count] = count
+      messages(attrs)
+    end
+
+    ##
+    #
+    # 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 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
+    def messages_for_user_id(user_id, count: 1, **attrs)
+      attrs[:userId] = user_id
+      attrs[:count] = count
+      messages(attrs)
+    end
+
+    private def messages(**attrs)
+      Iterable.request(conf, '/inApp/getMessages', attrs).get
+    end
+  end
+end

data/lib/iterable/metadata_table.rb

@@ -82,9 +82,7 @@ module Iterable
       Iterable.request(conf, base_path(key)).delete
     end
 
-    private
-
-    def base_path(key = nil)
+    private def base_path(key = nil)
       path = "/metadata/#{@name}"
       path += "/#{key}" if key
       path

data/lib/iterable/request.rb

@@ -34,33 +34,35 @@ module Iterable
       execute :put, body, headers
     end
 
-    def delete(headers = {})
-      execute :delete, {}, headers
+    def patch(body = {}, headers = {})
+      execute :patch, body, headers
     end
 
-    private
+    def delete(body = {}, headers = {})
+      execute :delete, body, headers
+    end
 
-    def execute(verb, body = {}, headers = {})
+    private def execute(verb, body = {}, headers = {})
       http = connection(verb, body, headers)
       setup_http(http)
       transmit http
     end
 
-    def connection(verb, body = {}, headers = {})
+    private def connection(verb, body = {}, headers = {})
       conn_headers = DEFAULT_HEADERS.merge(headers)
       req = Net::HTTP.const_get(verb.to_s.capitalize, false).new(@uri, conn_headers)
       req.body = JSON.dump(body)
       req
     end
 
-    def setup_http(http)
+    private def setup_http(http)
       DEFAULT_OPTIONS.dup.each do |option, value|
         setter = "#{option.to_sym}="
         http.send(setter, value) if http.respond_to?(setter)
       end
     end
 
-    def build_uri(path, params = {})
+    private def build_uri(path, params = {})
       uri = @config.uri
       uri.path += path
       params['api_key'] = @config.token
@@ -68,11 +70,11 @@ module Iterable
       uri
     end
 
-    def net_http
+    private def net_http
       Net::HTTP.new(@uri.hostname, @uri.port, nil, nil, nil, nil)
     end
 
-    def transmit(req)
+    private def transmit(req)
       response = nil
       @net.start do |http|
         response = http.request(req, nil, &:read_body)
@@ -80,7 +82,7 @@ module Iterable
       handle_response response
     end
 
-    def handle_response(response)
+    private def handle_response(response)
       redirected = response.is_a?(Net::HTTPRedirection) || response.code == '303'
       if redirected && response['location']
         Response.new Net::HTTP.get_response(uri_for_redirect(response))
@@ -89,7 +91,7 @@ module Iterable
       end
     end
 
-    def uri_for_redirect(response)
+    private def uri_for_redirect(response)
       uri = @config.uri
       redirect_uri = URI(response['location'])
       uri.path = redirect_uri.path

data/lib/iterable/response.rb

@@ -12,7 +12,7 @@ module Iterable
     attr_reader :body
 
     # @!visibility private
-    def initialize(resp) # @private
+    def initialize(resp)
       @resp = resp
       @body = parsed_body
     end
@@ -29,14 +29,12 @@ module Iterable
       end
     end
 
-    private
-
     ##
     # Attempts to parse the response as JSON. Will rescue and return original
     # if unable to parse.
     #
     # @return [Hash,Array,String] A parsed JSON object or the original response body
-    def parsed_body
+    private def parsed_body
       response_body = @resp.body
       MultiJson.load response_body
     rescue MultiJson::ParseError

data/lib/iterable/users.rb

@@ -186,5 +186,18 @@ module Iterable
       params[:endTime] = end_time.to_s if end_time
       Iterable.request(conf, '/users/getSentMessages', params).get
     end
+
+    ##
+    #
+    # Delete the specified user's data from the Iterable project and
+    # prevent future data collection about them.
+    #
+    # @param email [String] User email to forget
+    #
+    # @return [Iterable::Response] A response object
+    def forget(email)
+      attrs = { email: email }
+      Iterable.request(conf, '/users/forget').post(attrs)
+    end
   end
 end

data/lib/iterable.rb

@@ -6,6 +6,10 @@ require 'multi_json'
 
 files = %w[
   api_resource
+  bulk_catalog_items
+  catalogs
+  catalog_field_mappings
+  catalog_items
   config
   response
   request
@@ -13,6 +17,7 @@ files = %w[
   campaigns
   channels
   events
+  in_app
   message_types
   templates
   email_templates
@@ -38,8 +43,6 @@ files.each { |path| require_relative "./iterable/#{path}" }
 module Iterable
   DATE_FORMAT = '%Y-%m-%d'.freeze
 
-  module_function
-
   ##
   #
   # Configure a default [Iterable::Config] object to be used when interacting
@@ -49,7 +52,7 @@ module Iterable
   #   Iterable.configure do |conf|
   #     conf.token = 'secret-token'
   #   end
-  def configure
+  module_function def configure
     config.tap do |conf|
       yield conf
     end
@@ -58,12 +61,12 @@ module Iterable
   ##
   #
   # @return [Iterable::Config] The default config for API endpoints
-  def config
+  module_function def config
     @config ||= Config.new
   end
 
   # @!visibility private
-  def request(conf, path, params = {})
+  module_function def request(conf, path, params = {})
     Request.new conf, path, params
   end
 end

metadata

@@ -1,36 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: iterable-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Chavez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdjb250
+  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMRAwDgYDVQQDDAdjb250
   YWN0MRkwFwYKCZImiZPyLGQBGRYJZWwtY2hhdmV6MRIwEAYKCZImiZPyLGQBGRYC
-  bWUwHhcNMTcxMDA0MTY0OTE5WhcNMTgxMDA0MTY0OTE5WjBBMRAwDgYDVQQDDAdj
+  bWUwHhcNMjIwNTE2MTYzNDEwWhcNMjMwNTE2MTYzNDEwWjBBMRAwDgYDVQQDDAdj
   b250YWN0MRkwFwYKCZImiZPyLGQBGRYJZWwtY2hhdmV6MRIwEAYKCZImiZPyLGQB
-  GRYCbWUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD3S1PMDhKEvRYX
-  p6AoUsx/fAycagXv3WvLQuFB95HXHOQ0kcoy08GCSjy0ZExOAUS8KV3eIWtL49dp
-  UkgHP/lYbWb7fr+89YLu5TbsZiGiNuXCxeice8oW2czH0bRXZ3hVbiI8zH6A/SKf
-  ugDi14TpugfDPEPO5lk0rTui1/+/3lD+B8TjezihJ5lRf8zG1jHv1ukzOg8QcmOd
-  yBl1ej3NSY1oT7B1x8mtEGhtVFeguVwmrWdjXTBqV8cPWT1F6PmciOf6C8y6Ag37
-  evUHIEm+zmz00mvSnNt5fy8vxFMdNYWGV62IhKJXoAmWEDkSXVF05PfJN+9J28/H
-  HghllVKbAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSKVaQXw8IuISmQQFhwF0MXmaquFTAfBgNVHREEGDAWgRRjb250YWN0QGVsLWNo
-  YXZlei5tZTAfBgNVHRIEGDAWgRRjb250YWN0QGVsLWNoYXZlei5tZTANBgkqhkiG
-  9w0BAQUFAAOCAQEA7RxRH2gQ7g/ytmR9yrp1YvAd94Bb2ePWrqFvLhRtfN6cL5TZ
-  CrbzSseqAA2jKWEkjvEhvsCjEevghsDikHbPPrXooY7q7zawD1cdhFwFJMwLlX//
-  HuSCfkWqT8GMM8QDn12sJ1G9fnFVGEeX35w99JHrVoL5oJCnjApXs6dm3tAay2Hv
-  mQBXsAeLSKWF9hmS4tLQLiJU8AZqv9TxBfk49iXHbY41LuoKMZv7b2OuHqX9cdz1
-  Gyzp8WFLv1yPdHyGqulJLNTeTrX6l88VkaUp438wtcWQoM+Qpuf4m8tEyVDmkhQz
-  322/Jzl3jLNyDSMXzBnKNIkLVYY5ifp7cropxQ==
+  GRYCbWUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCZc8MEuKWEAM8X
+  WCwtJ5yVgTzIbBFWo/Rq9RDBV5QHEGtkxqi4tvxcAP5Gw+iXxnfsysEOfTDa1FNw
+  YMhh38X9Ob7y3F/3G4CMu0MHGgIbzbQMs58pBfyBCB9u9ELVyzrHt4okThHG+KgN
+  EUD1FwgXeZCpjipx35y9QVO1Oax46p4cJo3UStEBHebkkU4P6Ch8OC39Neg2RGLI
+  oczDtOOP2hv/dqlgtCnOpuT48ycyJ4c/34/TXAPOZZy6buF9xZCR4yyoIB+qOtHP
+  cjdf2GBZIjsNtVvl8OIM1yotJRnndujKnAuFuPppOjnYD8xfm/qj2EApgVyjuWpg
+  2ltbeYmeU4sbi7W1IuSLe4TDDveSLJh5AAbSUC31diSdksx67nmhDYlqN1HTPWLY
+  yv1rEPz8vlQikzfwwL/vdhYocxzsMV0B+y3bonq40GJ2MWFROdwpct+D26Jo3Y+C
+  jJ6XeJosdueHvYBB1jy7j4QNOEBXDcwM80Kab1FUq469TbjTOPECAwEAAaN7MHkw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFM58c7sLuFcAZthV1ngO
+  0x3oyP02MB8GA1UdEQQYMBaBFGNvbnRhY3RAZWwtY2hhdmV6Lm1lMB8GA1UdEgQY
+  MBaBFGNvbnRhY3RAZWwtY2hhdmV6Lm1lMA0GCSqGSIb3DQEBCwUAA4IBgQAAjCBc
+  p5GzU6dOAe1afNSBn31KSYQedp0idL7TLLDBlUEAOPkBGxZvYG+78NOlw/12ci2E
+  H7oLWs2WNrIl6LwGVpueveEOTxqgvkhxPM/+8hvA1Rb5I9eCcLJrOvk36K/1LDyR
+  HSrSHnFDIk5wlSNCLK+pVOTS1s1wbXlV/DfuncKgDeGQKW9aQ5jHBZjk0u23qbox
+  j8goGrnX72zOv7ysPYDebJwpXjMXv8k+69M7CkCkeqTO8sRxnszNpnlB6DMqIhnI
+  bU76Xth/U7KdRV/d4bdBAMait/SQDJd+EjwTS2vvbpuEEJwLNN3/+DViQ0CA+vGC
+  bP6SNtxoWX20A6bkT2pf19J77p1LNFQAtQ2uUWqoXHdhtUvmpo28/WH/WY1CGuhP
+  skirV2p91csPqqACuQCX2oK9r29QZtt95aAnVdsdBMA+evI2nVknO0OhYDqNA0wR
+  SkUCdTSDgV9CsbN/vy6DeR0eX1kP6OrntZJjKnrncbkKZnrJ5fjzKtUyj3I=
   -----END CERTIFICATE-----
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -192,14 +197,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.89.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -220,14 +225,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -248,14 +253,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.8.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -282,7 +287,11 @@ files:
 - lib/iterable-api-client.rb
 - lib/iterable.rb
 - lib/iterable/api_resource.rb
+- lib/iterable/bulk_catalog_items.rb
 - lib/iterable/campaigns.rb
+- lib/iterable/catalog_field_mappings.rb
+- lib/iterable/catalog_items.rb
+- lib/iterable/catalogs.rb
 - lib/iterable/channels.rb
 - lib/iterable/commerce.rb
 - lib/iterable/config.rb
@@ -293,6 +302,7 @@ files:
 - lib/iterable/events.rb
 - lib/iterable/experiments.rb
 - lib/iterable/export.rb
+- lib/iterable/in_app.rb
 - lib/iterable/json_exporter.rb
 - lib/iterable/lists.rb
 - lib/iterable/message_types.rb
@@ -309,7 +319,7 @@ homepage: http://gitlab.com/mtchavez/iterable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 - "--main=README.md"
@@ -319,16 +329,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Iterable REST API Client
 test_files: []