@salesforce/lds-adapters-marketing-prospect 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,309 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '65.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  ConversionEntriesRepresentation:
+    description: Represents the list of entries in the Prospect to Lead Conversion
+    type: object
+    properties:
+      conversionEntries:
+        description: The list of entries
+        type: array
+        items:
+          type: ConversionEntryRepresentation
+      postConversionEntries:
+        description: The list of entries for post request
+        type: array
+        required: false
+        items:
+          type: ConversionEntryRepresentation
+  ConversionEntryRepresentation:
+    description: Represents an individual entry in the Conversion
+    type: object
+    properties:
+      accountId:
+        description: accountId
+        type: string
+      apiErrorCode:
+        description: apiErrorCode
+        type: string
+      contactId:
+        description: contactId
+        type: string
+      exceptionMsg:
+        description: exceptionMsg
+        type: string
+      httpStatusCode:
+        description: httpStatusCode
+        type: string
+      leadId:
+        description: leadId
+        type: string
+      opportunityId:
+        description: opportunityId
+        type: string
+      prospectId:
+        description: prospectId
+        type: string
+  ConversionPostInputRepresentation:
+    description: An Input Representation on Prospect Conversion Request
+    type: object
+    properties:
+      accountName:
+        description: AccountName input for Conversion to Account
+        type: string
+      contactFirstName:
+        description: FirstName input for Conversion to Contact
+        type: string
+      contactLastName:
+        description: LastName input for Conversion to Contact
+        type: string
+      contactSalutation:
+        description: Salutation input for Conversion to Contact
+        type: string
+      convertedStatus:
+        description: Converted Status
+        type: string
+      createOpportunity:
+        description: Boolean which decides whether the prospect should be allowed to convert to opportunity
+        type: boolean
+      existingAccountId:
+        description: Existing Account ID for conversion to Account
+        type: string
+      existingContactId:
+        description: Existing Contact ID for conversion to Contact
+        type: string
+      existingLeadId:
+        description: Existing Lead ID for conversion to Lead
+        type: string
+      existingOpportunityId:
+        description: Existing Opportunity Id for conversion to Opportunity when CreateOpportunity is true
+        type: string
+      leadCompany:
+        description: Company input for Conversion to Lead
+        type: string
+      leadFirstName:
+        description: FirstName for Conversion to Lead
+        type: string
+      leadLastName:
+        description: LastName input for Conversion to Lead
+        type: string
+      leadSalutation:
+        description: Salutation input for Conversion to Lead
+        type: string
+      opportunityName:
+        description: OpportunityName for conversion to Opportunity when CreateOpportunity is true
+        type: string
+      ownerId:
+        description: Owner ID which will be assigned to the entity post conversion
+        type: string
+      prospectId:
+        description: ProspectId
+        type: string
+  FieldInfo:
+    description: Represents field information
+    type: object
+    properties:
+      apiName:
+        description: The API name of the field
+        type: string
+      dataType:
+        description: The data type of the field
+        type: string
+      label:
+        description: The label of the field
+        type: string
+      qualifiedApiName:
+        description: The qualified API name of the field
+        type: string
+  FieldMapping:
+    description: Represents a field mapping between input and output fields
+    type: object
+    properties:
+      inputField:
+        description: The input field name
+        type: string
+      outputField:
+        description: The output field name
+        type: string
+  FieldMappingInput:
+    description: Input representation for field mapping between input and output fields
+    type: object
+    properties:
+      inputField:
+        description: The input field name
+        type: string
+        required: false
+      outputField:
+        description: The output field name
+        type: string
+        required: false
+  InputObjectFieldMapping:
+    description: Input representation for field mappings for a specific output object
+    type: object
+    properties:
+      mappedFields:
+        description: The list of mapped fields for this output object
+        type: array
+        items:
+          type: FieldMapping
+        required: false
+      outputObject:
+        description: The output object name (e.g., Lead)
+        type: string
+        required: false
+  OutputObjectFieldMapping:
+    description: Represents field mappings for a specific output object
+    type: object
+    additionalProperties: true
+    properties:
+      mappedFields:
+        description: The list of mapped fields for this output object
+        type: array
+        items:
+          type: FieldMapping
+      outputObject:
+        description: The output object name (e.g., Lead)
+        type: string
+      unmappedInputObjectFields:
+        description: The list of unmapped input object fields for this output object
+        type: array
+        items:
+          type: FieldInfo
+      unmappedOutputObjectFields:
+        description: The list of unmapped fields for this output object
+        type: array
+        items:
+          type: FieldInfo
+  ProspectFieldMappingInputRepresentation:
+    description: Input Representation for saving Prospect Field Mappings
+    type: object
+    properties:
+      inputObjectFieldMappings:
+        description: List of input object field mappings, each containing mappings for a specific output object
+        type: array
+        items:
+          type: InputObjectFieldMapping
+        required: false
+  ProspectFieldMappingOutputGetRepresentation:
+    description: Represents the mappings and available fields for Prospect to Lead conversion (GET operation)
+    type: object
+    additionalProperties: true
+    properties:
+      apiErrorCode:
+        description: API error code for detailed error categorization
+        type: string
+      apiErrorMsg:
+        description: API error message providing detailed error information
+        type: string
+      httpStatusCode:
+        description: 'HTTP status code indicating the response status: 200 (success), 204 (no content), 500 (error)'
+        type: string
+      outputObjectFieldMappings:
+        description: The list of output object field mappings with mapped and unmapped fields
+        type: array
+        items:
+          type: OutputObjectFieldMapping
+  ProspectFieldMappingOutputPostRepresentation:
+    description: Represents the mappings and available fields for Prospect to Lead conversion (POST operation)
+    type: object
+    additionalProperties: true
+    properties:
+      apiErrorCode:
+        description: API error code for detailed error categorization
+        type: string
+      apiErrorMsg:
+        description: API error message providing detailed error information
+        type: string
+      httpStatusCode:
+        description: 'HTTP status code indicating the response status: 200 (success), 204 (no content), 500 (error)'
+        type: string
+/connect:
+  /ProspectConversion:
+    get:
+      displayName: getProspectEntries
+      description: Get entries for the Conversation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConversionEntriesRepresentation
+      queryParameters:
+        contactMap:
+          type: string
+          required: false
+        leadMap:
+          type: string
+          required: false
+        owner:
+          type: string
+          required: false
+        personAccountMap:
+          type: string
+          required: false
+        prospectId:
+          type: string
+          required: false
+        status:
+          type: string
+          required: false
+    post:
+      displayName: postProspectEntries
+      description: Convert Prospect
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConversionEntriesRepresentation
+      body:
+        application/json:
+          type: ConversionPostInputRepresentation
+          (oas-body-name): conversionRequestBody
+  /ProspectFieldMapping:
+    get:
+      displayName: getProspectFieldMapping
+      description: Get Prospect Field Mappings
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProspectFieldMappingOutputGetRepresentation
+    post:
+      displayName: postProspectFieldMapping
+      description: Save Prospect Field Mappings
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProspectFieldMappingOutputPostRepresentation
+      body:
+        application/json:
+          type: ProspectFieldMappingInputRepresentation
+          (oas-body-name): prospectFieldMappingInput

package/src/raml/luvio.raml

@@ -0,0 +1,62 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Prospect'
+(luvio.ttl): 3000000
+
+types:
+  ConversionEntriesRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 60000
+  ConversionEntryRepresentation:
+    (luvio.key):
+      leadId: leadId
+    (luvio.ttl): 60000
+  ConversionPostInputRepresentation:
+    (luvio.key):
+      prospectId: prospectId
+    (luvio.ttl): 60000
+  FieldInfo:
+    (luvio.opaque): true
+    (luvio.ttl): 60000
+  FieldMapping:
+    (luvio.opaque): true
+    (luvio.ttl): 60000
+  FieldMappingInput:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  OutputObjectFieldMapping:
+    (luvio.key):
+      outputObject: outputObject
+    (luvio.ttl): 1000
+  InputObjectFieldMapping:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ProspectFieldMappingInputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ProspectFieldMappingOutputGetRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ProspectFieldMappingOutputPostRepresentation:
+    (luvio.key):
+      httpStatusCode: httpStatusCode
+    (luvio.ttl): 500
+/connect/ProspectConversion:
+  get:
+    (luvio.adapter):
+      name: getConversionEntries
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: getPostConversionEntries
+/connect/ProspectFieldMapping:
+  get:
+    (luvio.adapter):
+      name: getProspectFieldMappings
+  post:
+    (luvio.adapter):
+      name: saveProspectFieldMappings