Merge branch 'upstream'

# Conflicts:
#	connect/models/fulfillment.py

Author: JaviCerveraIngram

connect/exceptions.py

@@ -6,6 +6,7 @@
 from typing import List
 
 from deprecation import deprecated
+import six
 
 from .models.parameters import Param
 
@@ -25,6 +26,9 @@ class Message(Exception):
     """ (str) Additional information. """
 
     def __init__(self, message='', code='', obj=None):
+        # On Python 2, Unicode messages must be utf-8 encoded
+        if six.PY2 and isinstance(message, six.string_types) and not isinstance(message, str):
+            message = message.encode('utf-8')
         super(Message, self).__init__(message)
         self.code = code
         self.obj = obj
@@ -141,11 +145,3 @@ class FileRetrievalError(Message):
     def __init__(self, message):
         # type: (str) -> None
         super(FileRetrievalError, self).__init__(message, 'fileretrieval')
-
-
-class MigrationAbortError(Exception):
-    pass
-
-
-class MigrationParamError(Exception):
-    pass

connect/models/__init__.py

@@ -9,6 +9,7 @@
 from .company import Company, User
 from .connection import Connection
 from .contact import Contact, ContactInfo, PhoneNumber
+from .conversation import Conversation, ConversationMessage
 from .event import EventInfo, Events
 from .fulfillment import Fulfillment
 from .hub import Hub, HubInstance, ExtIdHub, HubStats
@@ -17,12 +18,10 @@
 from .product import CustomerUiSettings, Document, DownloadLink, Item, Product, \
     ProductConfiguration, Renewal
 from .server_error_response import ServerErrorResponse
-from .tier_config import Account, Template, TierConfig, TierConfigRequest
-from .tiers import Tier, Tiers
+from .tier_config import Template, TierAccount, TierAccounts, TierConfig, TierConfigRequest
 from .usage import UsageFile, UsageListing, UsageRecord, UsageRecords
 
 __all__ = [
-    'Account',
     'Activation',
     'ActivationTemplateResponse',
     'ActivationTileResponse',
@@ -36,6 +35,8 @@
     'Contact',
     'ContactInfo',
     'Contract',
+    'Conversation',
+    'ConversationMessage',
     'CustomerUiSettings',
     'Document',
     'DownloadLink',
@@ -55,10 +56,10 @@
     'Renewal',
     'ServerErrorResponse',
     'Template',
-    'Tier',
+    'TierAccount',
+    'TierAccounts',
     'TierConfig',
     'TierConfigRequest',
-    'Tiers',
     'UsageFile',
     'UsageListing',
     'UsageRecord',

connect/models/asset.py

@@ -9,7 +9,7 @@
 from .connection import Connection
 from .parameters import Param
 from .product import Item, Product
-from .tiers import Tiers
+from .tier_config import TierAccounts
 from connect.models.schemas import AssetSchema
 
 
@@ -71,8 +71,8 @@ class Asset(BaseModel):
     params = None  # type: List[Param]
     """ (List[:py:class:`.Param`]) List of product parameter objects. """
 
-    tiers = None  # type: Tiers
-    """ (:py:class:`.Tiers`) Supply chain accounts. """
+    tiers = None  # type: TierAccounts
+    """ (:py:class:`.TierAccounts`) Supply chain accounts. """
 
     def get_param_by_id(self, id_):
         """ Get a parameter of the asset.

connect/models/base.py

@@ -40,6 +40,7 @@ def deserialize(cls, json_str):
         :param str json_str: String containing the JSON data to be deserialized.
         :return: An instance of the same class as the receiver of the call, or a list of instances.
         :rtype: Any|list[Any]
+        :raises TypeError: Raised if the data cannot be deserialized.
         """
         return cls.deserialize_json(json.loads(json_str))
 
@@ -50,6 +51,7 @@ def deserialize_json(cls, json_data):
         :param dict|list json_data: JSON list or dictionary to be deserialized.
         :return: An instance of the same class as the receiver of the call, or a list of instances.
         :rtype: Any|list[Any]
+        :raises TypeError: Raised if the data cannot be deserialized.
         """
         objects, error = cls._schema.load(json_data, many=isinstance(json_data, list))
         if error:

connect/models/conversation.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect SDK.
+# Copyright (c) 2019 Ingram Micro. All Rights Reserved.
+
+import datetime
+
+from typing import List
+
+from .base import BaseModel
+from .company import User
+from connect.models.schemas import ConversationMessageSchema, ConversationSchema
+
+
+class ConversationMessage(BaseModel):
+    """ Message in a :py:class:`.Conversation`. """
+
+    _schema = ConversationMessageSchema()
+
+    conversation = None  # type: str
+    """ (str) Primary ID of Conversation object. """
+
+    created = None  # type: datetime.datetime
+    """ (datetime.datetime) Date of the Message creation. """
+
+    creator = None  # type: User
+    """ (:py:class:`.User`) :py:class:`.User` that created the message. """
+
+    text = None  # type: str
+    """ (str) Actual message. """
+
+
+class Conversation(BaseModel):
+    """ Conversation. """
+
+    _schema = ConversationSchema()
+
+    instance_id = None  # type: str
+    """ (str)  The id of object based on which discussion is made, e.g. listing request.
+    It can be any object.
+    """
+
+    created = None  # type: datetime.datetime
+    """ (datetime.datetime) Date of the Conversation creation. """
+
+    topic = None  # type: str
+    """ (str) Conversation topic. """
+
+    messages = None  # type: List[ConversationMessage]
+    """ (List[:py:class:`.ConversationMessage`]) List of :py:class:`.ConversationMessage`
+    objects.
+    """
+
+    creator = None  # type: User
+    """ (:py:class:`.User`) Creator of the conversation. """
+
+    def add_message(self, message, config=None):
+        """ Adds a message to the conversation.
+
+        :param str message: Message to add.
+        :param Config config: Configuration, or ``None`` to use the environment config (default).
+        :return: The added message.
+        :rtype: ConversationMessage
+        :raises TypeError: Raised if the message cannot be deserialized.
+        """
+
+        from connect.resources.base import ApiClient
+        response, _ = ApiClient(config, base_path='conversations/' + self.id + '/messages')\
+            .post(json={'text': message})
+        return ConversationMessage.deserialize(response)

connect/models/fulfillment.py

@@ -7,6 +7,7 @@
 
 from .asset import Asset
 from .base import BaseModel
+from .conversation import Conversation
 from .marketplace import Contract, Marketplace
 from connect.models.schemas import FulfillmentSchema
 
@@ -113,3 +114,23 @@ def needs_migration(self, migration_key='migration_info'):
         :rtype: bool
         """
         return self.asset.get_param_by_id(migration_key) is not None
+
+    def get_conversation(self, config=None):
+        """
+        :param Config config: Configuration, or ``None`` to use the environment config (default).
+        :return: The conversation for this request, or ``None`` if there is none.
+        :rtype: Conversation|None
+        """
+        from connect.resources.base import ApiClient
+
+        client = ApiClient(config, base_path='conversations')
+        response, _ = client.get(params={'instance_id': self.id})
+        try:
+            conversations = Conversation.deserialize(response)
+            if conversations and conversations[0].id:
+                response, _ = client.get(conversations[0].id)
+                return Conversation.deserialize(response)
+            else:
+                return None
+        except ValueError:
+            return None

connect/models/schemas.py

@@ -85,18 +85,6 @@ def make_object(self, data):
         return ContactInfo(**data)
 
 
-class AccountSchema(BaseSchema):
-    name = fields.Str()
-    external_id = fields.Str(allow_none=True)
-    external_uid = fields.Str(allow_none=True)
-    contact_info = fields.Nested(ContactInfoSchema)
-
-    @post_load
-    def make_object(self, data):
-        from connect.models import Account
-        return Account(**data)
-
-
 class ValueChoiceSchema(Schema):
     value = fields.Str()
     label = fields.Str()
@@ -396,27 +384,27 @@ def make_object(self, data):
         return Template(**data)
 
 
-class TierSchema(BaseSchema):
+class TierAccountSchema(BaseSchema):
     name = fields.Str()
     contact_info = fields.Nested(ContactInfoSchema)
     external_id = fields.Str()
     external_uid = fields.Str()
 
     @post_load
     def make_object(self, data):
-        from connect.models import Tier
-        return Tier(**data)
+        from connect.models import TierAccount
+        return TierAccount(**data)
 
 
-class TiersSchema(Schema):
-    customer = fields.Nested(TierSchema)
-    tier1 = fields.Nested(TierSchema)
-    tier2 = fields.Nested(TierSchema)
+class TierAccountsSchema(Schema):
+    customer = fields.Nested(TierAccountSchema)
+    tier1 = fields.Nested(TierAccountSchema)
+    tier2 = fields.Nested(TierAccountSchema)
 
     @post_load
     def make_object(self, data):
-        from connect.models import Tiers
-        return Tiers(**data)
+        from connect.models import TierAccounts
+        return TierAccounts(**data)
 
 
 class ConnectionSchema(BaseSchema):
@@ -442,7 +430,7 @@ class AssetSchema(BaseSchema):
     )
     items = fields.Nested(ItemSchema, many=True)
     params = fields.Nested(ParamSchema, many=True)
-    tiers = fields.Nested(TiersSchema)
+    tiers = fields.Nested(TierAccountsSchema)
 
     @post_load
     def make_object(self, data):
@@ -471,7 +459,7 @@ def make_object(self, data):
 
 class TierConfigSchema(BaseSchema):
     name = fields.Str()
-    account = fields.Nested(AccountSchema)
+    account = fields.Nested(TierAccountSchema)
     product = fields.Nested(ProductSchema)
     tier_level = fields.Int()
     connection = fields.Nested(ConnectionSchema)
@@ -579,3 +567,28 @@ class UsageRecordSchema(BaseSchema):
     def make_object(self, data):
         from connect.models import UsageRecord
         return UsageRecord(**data)
+
+
+class ConversationMessageSchema(BaseSchema):
+    conversation = fields.Str()
+    created = fields.DateTime()
+    creator = fields.Nested(UserSchema)
+    text = fields.Str()
+
+    @post_load
+    def make_object(self, data):
+        from connect.models import ConversationMessage
+        return ConversationMessage(**data)
+
+
+class ConversationSchema(BaseSchema):
+    instance_id = fields.Str()
+    created = fields.DateTime()
+    topic = fields.Str()
+    messages = fields.Nested(ConversationMessageSchema, many=True)
+    creator = fields.Nested(UserSchema)
+
+    @post_load
+    def make_object(self, data):
+        from connect.models import Conversation
+        return Conversation(**data)

connect/models/tier_config.py

@@ -13,24 +13,41 @@
 from .marketplace import Activation
 from .parameters import Param
 from .product import Product
-from .schemas import AccountSchema, TemplateSchema, TierConfigSchema, TierConfigRequestSchema
+from connect.models.schemas import TemplateSchema, TierAccountSchema, \
+    TierAccountsSchema, TierConfigSchema, TierConfigRequestSchema
 
 
-class Account(BaseModel):
+class TierAccount(BaseModel):
     """ Tier account. """
 
-    _schema = AccountSchema()
+    _schema = TierAccountSchema()
 
     name = None  # type: str
-    """ (str) Account name. """
+    """ (str) Tier name. """
+
+    contact_info = None  # type: ContactInfo
+    """ (:py:class:`.ContactInfo`) Tier Contact Object. """
 
     external_id = None  # type: Optional[str]
     """ (str|None) Only in case of filtering by this field. """
+
     external_uid = None  # type: Optional[str]
     """ (str|None) Only in case of filtering by this field. """
 
-    contact_info = None  # type: ContactInfo
-    """ (:py:class:`.ContactInfo`) Contact. """
+
+class TierAccounts(BaseModel):
+    """ TierAccounts object. """
+
+    _schema = TierAccountsSchema()
+
+    customer = None  # type: TierAccount
+    """ (:py:class:`.TierAccount`) Customer Level TierAccount Object. """
+
+    tier1 = None  # type: TierAccount
+    """ (:py:class:`.TierAccount`) Level 1 TierAccount Object. """
+
+    tier2 = None  # type: TierAccount
+    """ (:py:class:`.TierAccount`) Level 2 TierAccount Object. """
 
 
 class Template(BaseModel):
@@ -50,8 +67,10 @@ class TierConfig(BaseModel):
     name = None  # type: str
     """ (str) Tier configuration of account.name. """
 
-    account = None  # type: Account
-    """ (:py:class:`.Account`) Full tier account representation (same as in Asset). """
+    account = None  # type: TierAccount
+    """ (:py:class:`.TierAccount`) Full tier account representation
+    (same as in :py:class:`.Asset`).
+    """
 
     product = None  # type: Product
     """ (:py:class:`.Product`) Reference object to product (application). """
@@ -95,8 +114,8 @@ def get(cls, tier_id, product_id, config=None):
         response, _ = ApiClient(config, base_path='tier/config-requests').get(
             params={
                 'status': 'approved',
-                'configuration__product__id': product_id,
-                'configuration__account__id': tier_id,
+                'configuration.product.id': product_id,
+                'configuration.account.id': tier_id,
             }
         )
         objects = TierConfigRequest.deserialize(response)