@salesforce/lds-adapters-sales-people-api 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,196 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '57.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  NameUi:
+    description: Representation of parsed signature data's name
+    type: object
+    properties:
+      first:
+        description: The first name
+        type: string
+      initials:
+        description: The initials of this name
+        type: string
+      last:
+        description: The last name
+        type: string
+  PeopleAPIResponse:
+    description: Representation of parsed signature data
+    type: object
+    properties:
+      emailAddress:
+        description: The email address associated with this result. This is null if
+          fetching OOO information.
+        type: string
+      signature:
+        description: The signature data parsed for this email address.
+        type: SignatureUi
+  PeopleAPIResponseCollection:
+    description: Representation of parsed signature / OOO data for a list of emails
+      or contacts.
+    type: object
+    properties:
+      responses:
+        description: List of responses containing parsed signature data or OOO data
+        type: array
+        items:
+          type: PeopleAPIResponse
+  PhoneUi:
+    description: Representation of parsed signature data's phone number
+    type: object
+    properties:
+      countryCode:
+        description: The country code of this phone
+        type: string
+      extension:
+        description: The phone extension number
+        type: string
+      number:
+        description: The number of this phone number, might include the extension
+          / country code as well.
+        type: string
+      phoneType:
+        description: The type of phone number (e.g. cell, fax)
+        type: string
+  PhysAddressUi:
+    description: Representation of parsed signature data's address
+    type: object
+    properties:
+      apartment:
+        description: The apartment number (if present) associated with the address
+        type: string
+      city:
+        description: The name of the city of this address
+        type: string
+      country:
+        description: The country/nation for this address
+        type: string
+      houseNo:
+        description: The house number of this address. Does not include apartment
+          number.
+        type: string
+      poBox:
+        description: P.O. Box of the Address
+        type: string
+      postalCode:
+        description: Postal code of this address
+        type: string
+      state:
+        description: The state/region associated with this parsed data
+        type: string
+      street:
+        description: The name of the street of this address, without the number
+        type: string
+  SignatureUi:
+    description: Representation of parsed signature data
+    type: object
+    properties:
+      addresses:
+        description: List of Addresses associated with this email signature
+        type: array
+        items:
+          type: PhysAddressUi
+      companyName:
+        description: The company name parsed from this email
+        type: string
+      emailAddress:
+        description: The email address this signature data is associated with
+        type: string
+      hash:
+        description: Hash of the content of this signature api
+        type: string
+      name:
+        description: The parsed first name, initial, and last name
+        type: NameUi
+      phones:
+        description: The list of parsed phone number information and associated metadata
+        type: array
+        items:
+          type: PhoneUi
+      receivedTime:
+        description: The time where this engagement was crawled
+        type: string
+      sfdcOrgId:
+        description: The SFDC Organization ID
+        type: string
+      socialMediaUrls:
+        description: List of social media websites
+        type: array
+        items:
+          type: SocialMediaUi
+      title:
+        description: The parsed job title information
+        type: TitleUi
+      webUrls:
+        description: List of URLs that were parsed from this signature
+        type: array
+        items:
+          type: string
+  SocialMediaUi:
+    description: Representation of parsed signature data's social media listing
+    type: object
+    properties:
+      handle:
+        description: The username or handle used to identify this user on this social
+          media service
+        type: string
+      link:
+        description: The URL link parsed in this signature
+        type: string
+      service:
+        description: The name of the social media service this handle is associated
+          with
+        type: string
+  TitleUi:
+    description: Representation of parsed signature data's job title
+    type: object
+    properties:
+      function:
+        description: The general name of the job function without a level.
+        type: string
+      level:
+        description: The level or rank (if present) of this job title.
+        type: string
+      title:
+        description: The name or job title of this parsed Title information
+        type: string
+/people:
+  get:
+    description: Fetches parsed signature info
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: PeopleAPIResponseCollection
+    queryParameters:
+      emailAddresses:
+        type: array
+        required: false
+        items:
+          type: string
+          (oas-collectionFormat): csv

package/src/raml/luvio.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'people-api'
+(luvio.ttl): 3600000
+
+types:
+  PeopleAPIResponseCollection:
+    (luvio.opaque): true
+
+/people:
+  get:
+    (luvio.adapter):
+      name: getParsedSignatureData