Trendsic Platform Service

CustomerLinkCreateRequest

The following routes are available for this service:
POST,OPTIONS	/v1/customerlink

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerLink:
    customer_link_id: int = 0
    customer_link_u_i_d: Optional[str] = None
    token_hash: Optional[str] = None
    resource_type: Optional[str] = None
    resource_uid: Optional[str] = None
    sensitivity_tier: Optional[str] = None
    require_otp: bool = False
    otp_channel: Optional[str] = None
    delivery_channels: Optional[str] = None
    recipient_contact_id: Optional[int] = None
    recipient_email: Optional[str] = None
    recipient_phone: Optional[str] = None
    sms_consent_snapshot: bool = False
    created_by_user_id: Optional[str] = None
    created_by_agent_id: Optional[int] = None
    created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    expires_at_utc: Optional[datetime.datetime] = None
    max_views: Optional[int] = None
    view_count: int = 0
    revoked_at_utc: Optional[datetime.datetime] = None
    revoked_by_user_id: Optional[str] = None
    tenant_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerLinkExtended(CustomerLink):
    recipient_display_name: Optional[str] = None
    recipient_type: Optional[str] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerLinkCreateResponse:
    response_status: Optional[ResponseStatus] = None
    link: Optional[CustomerLinkExtended] = None
    portal_url: Optional[str] = None
    delivery_errors: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerLinkCreateRequest:
    resource_type: Optional[str] = None
    resource_uid: Optional[str] = None
    recipient_contact_id: Optional[int] = None
    recipient_email: Optional[str] = None
    recipient_phone: Optional[str] = None
    deliver_email: bool = False
    deliver_sms: bool = False
    expires_in_hours: Optional[int] = None
    max_views: Optional[int] = None

Python CustomerLinkCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/customerlink HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerLinkCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DeliverEmail>false</DeliverEmail>
  <DeliverSms>false</DeliverSms>
  <ExpiresInHours>0</ExpiresInHours>
  <MaxViews>0</MaxViews>
  <RecipientContactId>0</RecipientContactId>
  <RecipientEmail>String</RecipientEmail>
  <RecipientPhone>String</RecipientPhone>
  <ResourceType>String</ResourceType>
  <ResourceUid>00000000-0000-0000-0000-000000000000</ResourceUid>
</CustomerLinkCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerLinkCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DeliveryErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryErrors>
  <Link>
    <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
    <CreatedByAgentId>0</CreatedByAgentId>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <CustomerLinkId>0</CustomerLinkId>
    <CustomerLinkUID>00000000-0000-0000-0000-000000000000</CustomerLinkUID>
    <DeliveryChannels>String</DeliveryChannels>
    <ExpiresAtUtc>0001-01-01T00:00:00</ExpiresAtUtc>
    <MaxViews>0</MaxViews>
    <OtpChannel>String</OtpChannel>
    <RecipientContactId>0</RecipientContactId>
    <RecipientEmail>String</RecipientEmail>
    <RecipientPhone>String</RecipientPhone>
    <RequireOtp>false</RequireOtp>
    <ResourceType>String</ResourceType>
    <ResourceUid>00000000-0000-0000-0000-000000000000</ResourceUid>
    <RevokedAtUtc>0001-01-01T00:00:00</RevokedAtUtc>
    <RevokedByUserId>00000000-0000-0000-0000-000000000000</RevokedByUserId>
    <SensitivityTier>String</SensitivityTier>
    <SmsConsentSnapshot>false</SmsConsentSnapshot>
    <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    <TokenHash>String</TokenHash>
    <ViewCount>0</ViewCount>
    <RecipientDisplayName>String</RecipientDisplayName>
    <RecipientType>String</RecipientType>
    <Status>String</Status>
  </Link>
  <PortalUrl>String</PortalUrl>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomerLinkCreateResponse>