Release 3.1.0 (#234)

* Release 3.1.0

* Mention +[Intercom updateUserWithAttributes:] deprecation in changelog

Author: jtreanor

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Intercom
 
+## 3.1.0 (2017-02-27)
+
+* Added new GIF button to the composer in the Messenger, so your users can search for and share GIFs in conversations.
+* Updated image upload functionality.
+* Added `ICMUserAttributes` and `+[Intercom updateUser:]` to help make updating users easier. `+[Intercom updateUserWithAttributes:]` is now deprecated.
+* Improved behaviour in landscape on small devices.
+* Fixed issue where errors could be logged on first launch.
+
 ## 3.0.25 (2017-02-07)
 
 * Fixed an issue with `[Intercom enableLogging]` that caused debug logs not to be shown.

Intercom.framework.dSYM/Contents/Info.plist

@@ -13,7 +13,7 @@
 		<key>CFBundleSignature</key>
 		<string>????</string>
 		<key>CFBundleShortVersionString</key>
-		<string>3.0.25</string>
+		<string>3.1.0</string>
 		<key>CFBundleVersion</key>
 		<string>1</string>
 	</dict>

Intercom.framework.dSYM/Contents/Resources/DWARF/Intercom

@@ -0,0 +1,87 @@
+//
+//  ICMCompany.h
+//
+//  Created by Intercom on 17/01/2017.
+//  Copyright (c) 2017 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ * The ICMCompany object is used for adding companies to users in Intercom.
+ * All of the default attributes you can modify are available as properties on ICMCompany.
+ * This is an example of how to create an ICMCompany object to update default attributes.
+ *
+ *     ICMCompany *company = [ICMCompany new];
+ *     company.companyId = @"12345";
+ *     company.name = @"TestCorp";
+ *
+ * You can also add custom attributes to your company.
+ *
+ *     ICMCompany *company = [ICMCompany new];
+ *     company.companyId = @"12345";
+ *     company.name = @"TestCorp";
+ *     company.customAttributes = @{@"employee_count" : @200};
+ *
+ */
+@interface ICMCompany : NSObject
+
+/**
+ The ID of the company.
+ @note This property is required
+ */
+@property (nonatomic, copy, nullable) NSString *companyId;
+
+/**
+ The name of the company.
+ */
+@property (nonatomic, copy, nullable) NSString *name;
+
+/**
+ The created at date for this company.
+ */
+@property (nonatomic, strong, nullable) NSDate *createdAt;
+
+/**
+ The monthly spend of the company.
+ */
+@property (nonatomic, strong, nullable) NSNumber *monthlySpend;
+
+/**
+ The plan of the company.
+ */
+@property (nonatomic, copy, nullable) NSString *plan;
+
+/**
+ Custom attributes for this user.
+ @note Each key must be an NSString and each value must be of type NSString, NSNumber or NSNull.
+ */
+@property (nonatomic, strong, nullable) NSDictionary<NSString *, id> *customAttributes;
+
+/**
+ Gives you a null value to apply to string attributes.
+ 
+ @return the value to set on string attributes which you wish to be null
+ */
++ (nonnull NSString *)nullStringAttribute;
+
+/**
+ Gives you a null value to apply to number attributes.
+ 
+ @return the value to set on number attributes which you wish to be null
+ */
++ (nonnull NSNumber *)nullNumberAttribute;
+
+/**
+ Gives you a null value to apply to date attributes.
+ 
+ @return the value to set on date attributes which you wish to be null
+ */
++ (nonnull NSDate *)nullDateAttribute;
+
+/**
+ A dictionary representation for the company.
+ */
+- (nonnull NSDictionary<NSString *, id> *)attributes;
+
+@end

Intercom.framework/Headers/ICMCompany.h

@@ -0,0 +1,97 @@
+//
+//  ICMUserAttributes.h
+//
+//  Created by Intercom on 17/01/2017.
+//  Copyright (c) 2017 Intercom. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "ICMCompany.h"
+
+/**
+ The ICMUserAttributes object is used for updating a user in Intercom.
+ All of the default attributes you can modify are available as properties on ICMUserAttributes.
+ This is an example of how to create an ICMUserAttributes object to update default attributes
+ 
+     ICMUserAttributes *userAttributes = [ICMUserAttributes new];
+     userAttributes.userId = @"12345";
+     userAttributes.email = @"[email protected]";
+     userAttributes.name = @"Andy";
+ 
+ You can also add custom attributes to your user:
+ 
+     ICMUserAttributes *userAttributes = [ICMUserAttributes new];
+     userAttributes.userId = @"12345";
+     userAttributes.email = @"[email protected]";
+     userAttributes.customAttributes = @{@"items_in_cart" : @8};
+*/
+@interface ICMUserAttributes : NSObject
+
+/**
+ The email for this user.
+ */
+@property (nonatomic, copy, nullable) NSString *email;
+
+/**
+ The user ID for this user.
+ */
+@property (nonatomic, copy, nullable) NSString *userId;
+
+/**
+ The name of this user.
+ */
+@property (nonatomic, copy, nullable) NSString *name;
+
+/**
+ The phone number of this user.
+ */
+@property (nonatomic, copy, nullable) NSString *phone;
+
+/**
+ The signed up date for this user.
+ */
+@property (nonatomic, strong, nullable) NSDate *signedUpAt;
+
+/**
+ A boolean indicating if the user has unsubscribed from emails.
+ */
+@property (nonatomic, assign) BOOL unsubscribedFromEmails;
+
+/**
+ The companies for this user.
+ */
+@property (nonatomic, strong, nullable) NSArray<ICMCompany *> *companies;
+
+/**
+ Custom attributes for this user.
+ @note Each key must be an NSString and each value must be of type NSString, NSNumber or NSNull.
+ */
+@property (nonatomic, strong, nullable) NSDictionary<NSString *, id> *customAttributes;
+
+/**
+ Gives you a null value to apply to string attributes.
+ 
+ @return the value to set on string attributes which you wish to be null
+ */
++ (nonnull NSString *)nullStringAttribute;
+
+/**
+ Gives you a null value to apply to number attributes.
+ 
+ @return the value to set on number attributes which you wish to be null
+ */
++ (nonnull NSNumber *)nullNumberAttribute;
+
+/**
+ Gives you a null value to apply to date attributes.
+ 
+ @return the value to set on date attributes which you wish to be null
+ */
++ (nonnull NSDate *)nullDateAttribute;
+
+/**
+ A dictionary representation for the user attributes.
+ */
+- (nonnull NSDictionary<NSString *, id> *)attributes;
+
+@end

Intercom.framework/Headers/ICMUserAttributes.h

@@ -8,6 +8,7 @@
 
 #import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
+#import "ICMUserAttributes.h"
 
 #if __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_8_0
 #error This version (3.0.25) of Intercom for iOS supports iOS 8.0 upwards.
@@ -173,44 +174,17 @@ typedef NS_ENUM(NSUInteger, ICMPreviewPosition){
  You can send any data you like to Intercom. Typically our customers see a lot of value in sending data that
  relates to customer development, such as price plan, value of purchases, etc. Once these have been sent to
  Intercom you can then apply filters based on these attributes.
+ 
+ Details on attributes available to update can be found in ICMUserAttributes.
+ 
+ @param userAttributes The attributes to update the user with.
+ */
++ (void)updateUser:(ICMUserAttributes *)userAttributes;
 
- A detailed list of the fields you can use to [update a user is available here](https://developers.intercom.com/reference/#user-model )
-
- Attributes such as the user email or name can be updated by calling
-
- [Intercom updateUserWithAttributes:@{
- @"email" : @"[email protected]",
- @"name" : @"Admin Name"
- }];
-
- Custom user attributes can be created and modified by passing a custom_attributes dictionary
- You do not have to create attributes in Intercom beforehand. If one hasn't been seen before, it will be
- created for you automatically.
-
- [Intercom updateUserWithAttributes:@{
- @"custom_attributes": @{
- @"paid_subscriber" : @YES,
- @"monthly_spend": @155.5,
- @"team_mates": @3
- }
- }];
-
- You can also set company data via this call by submitting an attribute dictionary like
-
- [Intercom updateUserWithAttributes:@{
- @"companies": @[ @{
- @"name" : @"My Company",
- @"id" : @"abcd1234"
- }
- ]}];
-
- id is a required field for adding or modifying a company. A detailed description of the
- [company model is available here](https://developers.intercom.com/reference/#companies )
-
- @param attributes This is a dictionary containing key/value pairs for multiple attributes.
- @note Attributes may be either a `string`, `integer`, `double`, `unix timestamp` or `bool`.
+/*!
+ @deprecated  +[Intercom updateUserWithAttributes:] is deprecated. Use +[Intercom updateUser:] instead.
  */
-+ (void)updateUserWithAttributes:(NSDictionary *)attributes;
++ (void)updateUserWithAttributes:(NSDictionary *)attributes __attribute((deprecated("'+[Intercom updateUserWithAttributes:]' is deprecated. 'Use +[Intercom updateUser:]' instead.")));
 
 /*!
  Log an event with a given name.