@salesforce/lds-adapters-platform-external-connectivity 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,724 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.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:
+  AuthenticationParameterDefinitionRepresentation:
+    description: Output representation for External Connectivity Connector Authentication
+      Parameter Definition
+    type: object
+    properties:
+      description:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Description
+        type: string
+      helpText:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Help Text
+        type: string | nil
+      label:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Label
+        type: string
+      maxLength:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Max Length
+        type: integer
+      name:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Name
+        type: string
+      required:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Required Flag
+        type: boolean
+      secret:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Secret Flag
+        type: boolean
+      valueType:
+        description: External Connectivity Connector Authentication Parameter Definition
+          Value Type
+        type: string
+        enum:
+          - Boolean
+          - Email
+          - Number
+          - String
+          - Url
+  AuthenticationParameterRepresentation:
+    description: Output representation for External Connectivity Connection Authentication
+      Parameter
+    type: object
+    properties:
+      authenticationParameterDefinition:
+        description: External Connectivity Connection Authentication Parameter Definition
+        type: AuthenticationParameterDefinitionRepresentation
+      value:
+        description: External Connectivity Connection Authentication Parameter Value
+        type: string
+  AuthenticationTypeDefinitionRepresentation:
+    description: Output representation for External Connectivity Connector Authentication
+      Type Definition
+    type: object
+    properties:
+      authenticationParameterDefinitions:
+        description: External Connectivity Connector Authentication Parameter Definitions
+        type: array
+        items:
+          type: AuthenticationParameterDefinitionRepresentation
+      authenticationProtocol:
+        description: External Connectivity Connector Authentication Protocol
+        type: string
+        enum:
+          - Basic
+          - Custom
+          - OAuth2BrowserFlow
+  AuthenticationTypeInputRepresentation:
+    description: Input representation for authentication type
+    type: object
+    properties:
+      authenticationParameterInputs:
+        description: Sets the Authentication Parameter Inputs
+        type: array
+        items:
+          type: any
+      authenticationProtocol:
+        description: Sets the Authentication Protocol
+        type: string
+  AuthenticationTypeRepresentation:
+    description: Output representation for External Connectivity Connection Authentication
+      Type
+    type: object
+    properties:
+      authenticationParameters:
+        description: External Connectivity Connection Authentication Parameters
+        type: array
+        items:
+          type: AuthenticationParameterRepresentation
+      authenticationProtocol:
+        description: External Connectivity Connection Authentication Protocol
+        type: string
+        enum:
+          - Basic
+          - Custom
+  ConnectorIconMetadataRepresentation:
+    description: Output representation for Connector Icon Metadata
+    type: object
+    properties:
+      alternateText:
+        description: IconMetadata Alternate Text
+        type: string
+      name:
+        description: IconMetadata Name
+        type: string
+      resourceUrl:
+        description: IconMetadata Resource Url
+        type: string
+  ExternalConnectivityConnectionCreatedRepresentation:
+    description: Output representation for External Connectivity Connection Created
+    type: object
+    properties:
+      developerName:
+        description: External Connectivity Connection Developer Name
+        type: string
+  ExternalConnectivityConnectionDetailsRepresentation:
+    description: Output representation for External Connectivity Connection Details
+    type: object
+    properties:
+      authenticationType:
+        description: External Connectivity Connection Authentication Type
+        type: AuthenticationTypeRepresentation
+      agentActionEnabled:
+        description: External Connectivity Connection Agent Action Flag
+        type: boolean | nil # TODO Hand-rolled W-17603644
+        required: false # TODO Hand-rolled W-17603644
+      createdBy:
+        description: External Connectivity Connection Created By
+        type: string
+      createdById:
+        description: External Connectivity Connection Created By Id
+        type: string
+      createdDate:
+        description: External Connectivity Connection Created Date
+        type: string
+      description:
+        description: External Connectivity Connection Description
+        type: string | nil
+      developerName:
+        description: External Connectivity Connection Developer Name
+        type: string
+      established:
+        description: External Connectivity Connection Established Flag
+        type: boolean
+      externalConnectorMetadata:
+        description: External Connectivity Connection Connector Metadata
+        type: ExternalConnectivityConnectorRepresentation
+      lastModifiedBy:
+        description: External Connectivity Connection Last Modified By
+        type: string
+      lastModifiedById:
+        description: External Connectivity Connection Last Modified By Id
+        type: string
+      lastModifiedDate:
+        description: External Connectivity Connection Last Modified Date
+        type: string
+      lastTestedDate:
+        description: External Connectivity Connection Last Tested Date
+        type: string | nil
+      name:
+        description: External Connectivity Connection Name
+        type: string
+  ExternalConnectivityConnectionEditDeleteResultRepresentation:
+    description: Output representation for External Connectivity Connection Updated
+    type: object
+    properties:
+      developerName:
+        description: External Connectivity Connection Developer Name
+        type: string
+      errorDescription:
+        description: External Connectivity Connection Error Description
+        type: string | nil
+      errorMessage:
+        description: External Connectivity Connection Error Message
+        type: string | nil
+  ExternalConnectivityConnectionInputRepresentation:
+    description: Input representation for External Connectivity Connection
+    type: object
+    properties:
+      authenticationTypeInput:
+        description: Sets the Authentication Type Input
+        type: AuthenticationTypeInputRepresentation
+      agentActionEnabled:
+        description: Sets the Connection Enabled For Agent Action
+        type: boolean | nil # TODO Hand-rolled W-17603644
+        required: false # TODO Hand-rolled W-17603644
+      connectorDeveloperName:
+        description: Sets the Connector Developer Name
+        type: string
+      description:
+        description: Sets the description
+        type: string
+      name:
+        description: Sets the name
+        type: string
+  ExternalConnectivityConnectionListRepresentation:
+    description: Output representation for External Connectivity Connection List
+    type: object
+    properties:
+      connections:
+        description: List of External Connectivity Connections
+        type: array
+        items:
+          type: ExternalConnectivityConnectionRepresentation
+      connectorDeveloperName:
+        description: The Connector developer name for a filtered list of connections.
+        type: string | nil
+  ExternalConnectivityConnectionReferencedFlowsDefinitionRepresentation:
+    description: Output representation for flow definition referencing External Connectivity Connection
+    type: object
+    properties:
+      elementsUsingConnection:
+        description: List of elements referenced by the connection as part of flow
+        type: array
+        items:
+          type: string | nil
+      flowName:
+        description: Name of flow referenced by the connection
+        type: string | nil
+      flowStatus:
+        description: Status of flow referenced by the connection
+        type: string | nil
+      flowVersionId:
+        description: Version Id of flow referenced by the connection
+        type: string | nil
+      ownerName:
+        description: Owner of flow referenced by the connection
+        type: string | nil
+      flowVersionNumber:
+        description: Version number of flow referenced by the connection
+        type: string | nil
+  ExternalConnectivityConnectionFlowsGroupedByApiNameRepresentation:
+    description: Output representation for flows grouped by API name referencing External Connectivity Connection
+    type: object
+    properties:
+      apiName:
+        description: API name of flow referenced by the connection
+        type: string | nil
+      externalConnectivityConnectionReferencedFlowsDefinitionRepresentation:
+        description: List of flows referenced by the connection
+        type: array
+        items:
+          type: ExternalConnectivityConnectionReferencedFlowsDefinitionRepresentation
+  ExternalConnectivityConnectionReferencedFlowsRepresentation:
+    description: Output representation for Flows referenced by the External Connectivity Connection
+    type: object
+    properties:
+      connectionFullName:
+        description: External Connectivity Connection Name
+        type: string | nil
+      externalConnectivityConnectionFlowsGroupedByApiNameRepresentation:
+        description: List of API names along with the flows grouped by the API name referenced by the connection
+        type: array
+        items:
+          type: ExternalConnectivityConnectionFlowsGroupedByApiNameRepresentation
+  ExternalConnectivityConnectionRefreshMetadataTypeProviderRequestParametersRepresentation:
+    description: Input representation for External Connectivity Refresh Metadata Type Provider Request Parameters
+    type: object
+    properties:
+      metadataProviderName:
+        description: The name of the Connector action metadata provider
+        type: string
+        required: true
+      inputValues:
+        description: Input values for the Connector action
+        type: object
+        required: true
+        properties:
+          //:
+            type: any
+  ExternalConnectivityConnectionRefreshMetadataInputRepresentation:
+    description: Input representation for External Connectivity Connection Apex metadata
+      refresh
+    type: object
+    properties:
+      apexClassNames:
+        description: Sets the apexClassNames
+        type: array
+        required: false
+        items:
+          type: string
+      typeProviderRequestParameters:
+        description: Parameters to perform a type provider metadata request
+        type: array
+        required: false
+        items:
+          type: ExternalConnectivityConnectionRefreshMetadataTypeProviderRequestParametersRepresentation
+  ExternalConnectivityConnectionRefreshMetadataOutputRepresentation:
+    description: Output representation for External Connectivity Connection Apex metadata
+      refresh
+    type: object
+    properties:
+      apexClassNames:
+        description: List of Apex class names refreshed
+        type: array
+        items:
+          type: string
+      connectionName:
+        description: Connection developer name
+        type: string
+  ExternalConnectivityConnectionRepresentation:
+    description: Output representation for External Connectivity Connection
+    type: object
+    properties:
+      agentActionEnabled:
+        description: External Connectivity Connection Agent Action Flag
+        type: boolean | nil # TODO Hand-rolled W-17603644
+        required: false # TODO Hand-rolled W-17603644
+      createdBy:
+        description: External Connectivity Connection Created By
+        type: string
+      createdById:
+        description: External Connectivity Connection Created By Id
+        type: string
+      createdDate:
+        description: External Connectivity Connection Created Date
+        type: string
+      description:
+        description: External Connectivity Connection Description
+        type: string | nil
+      developerName:
+        description: External Connectivity Connection Developer Name
+        type: string
+      established:
+        description: External Connectivity Connection Established Flag
+        type: boolean
+      externalConnectorMetadata:
+        description: External Connectivity Connection Connector Metadata
+        type: ExternalConnectivityConnectorRepresentation
+      lastModifiedBy:
+        description: External Connectivity Connection Last Modified By
+        type: string
+      lastModifiedById:
+        description: External Connectivity Connection Last Modified By Id
+        type: string
+      lastModifiedDate:
+        description: External Connectivity Connection Last Modified Date
+        type: string
+      lastTestedDate:
+        description: External Connectivity Connection Last Tested Date
+        type: string | nil
+      name:
+        description: External Connectivity Connection Name
+        type: string
+  ExternalConnectivityConnectorDetailsRepresentation:
+    description: Output representation for External Connectivity Connector Details
+    type: object
+    properties:
+      connectorType:
+        description: External Connectivity Connector Type
+        type: string
+      description:
+        description: External Connectivity Connector Description
+        type: string
+      developerName:
+        description: External Connectivity Connector Developer Name
+        type: string
+      iconMetadata:
+        description: External Connectivity Connector Icon Metadata
+        type: array
+        items:
+          type: ConnectorIconMetadataRepresentation
+      label:
+        description: External Connectivity Connector Label
+        type: string
+      labelVersion:
+        description: External Connectivity Connector Label Version
+        type: string
+      majorVersion:
+        description: External Connectivity Connector Major Version
+        type: integer
+      releaseStatus:
+        description: External Connectivity Connector Release Status
+        type: string
+      supportedAuthenticationTypes:
+        description: External Connectivity Connector Supported Authentication Types
+        type: array
+        items:
+          type: AuthenticationTypeDefinitionRepresentation
+      vendor:
+        description: External Connectivity Connector Vendor
+        type: string
+      version:
+        description: External Connectivity Connector Version
+        type: string
+  ExternalConnectivityConnectorListRepresentation:
+    description: Output representation for External Connectivity Connector List
+    type: object
+    properties:
+      connectors:
+        description: List of external connectivity connectors
+        type: array
+        items:
+          type: ExternalConnectivityConnectorRepresentation
+  ExternalConnectivityConnectorRepresentation:
+    description: Output representation for External Connectivity Connector
+    type: object
+    properties:
+      connectorType:
+        description: External Connectivity Connector Type
+        type: string
+      description:
+        description: External Connectivity Connector Description
+        type: string
+      developerName:
+        description: External Connectivity Connector Developer Name
+        type: string
+      iconMetadata:
+        description: External Connectivity Connector Icon Metadata
+        type: array
+        items:
+          type: ConnectorIconMetadataRepresentation
+      label:
+        description: External Connectivity Connector Label
+        type: string
+      labelVersion:
+        description: External Connectivity Connector Label Version
+        type: string
+      majorVersion:
+        description: External Connectivity Connector Major Version
+        type: integer
+      releaseStatus:
+        description: External Connectivity Connector Release Status
+        type: string
+      vendor:
+        description: External Connectivity Connector Vendor
+        type: string
+      version:
+        description: External Connectivity Connector Version
+        type: string
+  ExternalConnectivityConnectionTestResultRepresentation:
+    description: Output representation for External Connectivity Connection Test Result
+    type: object
+    properties:
+      developerName:
+        description: The developer name
+        type: string
+      errorDetails:
+        description: The error details from testing the connection
+        type: string | nil
+      errorMessage:
+        description: The error message from testing the connection
+        type: string | nil
+      established:
+        description: Whether the connection was established or not
+        type: boolean
+      lastTestedDate:
+        description: The last time the connection test was attempted
+        type: string
+  IcStandardExternalIdentityProviderListRepresentation:
+    description: Output representation for Ic Standard External Identity Provider
+      List
+    type: object
+    properties:
+      identityProviderRepresentationList:
+        description: List of Ic Standard External Identity Providers
+        type: array
+        items:
+          type: IcStandardExternalIdentityProviderRepresentation
+  IcStandardExternalIdentityProviderRepresentation:
+    description: Output representation for Ic Standard External Identity Provider
+    type: object
+    properties:
+      environment:
+        description: Ic Standard External Identity Provider Environment
+        type: string
+      fullName:
+        description: Ic Standard External Identity Provider Full Name
+        type: string
+      label:
+        description: Ic Standard External Identity Provider Label
+        type: string
+      prefixedFullName:
+        description: Ic Standard External Identity Provider Prefixed Full Name
+        type: string
+  ExternalConnectivityInvocableActionInfoRepresentation:
+    description: Information about an Invocable Action
+    type: object
+    properties:
+      category:
+        description: Category of Invocable Action
+        type: string | nil
+      description:
+        description: Description of Invocable Action
+        type: string | nil
+      durableId:
+        description: getDurableId
+        type: string | nil
+      label:
+        description: Label of Invocable Action
+        type: string | nil
+      name:
+        description: Name of Invocable Action
+        type: string | nil
+      type:
+        description: Type of Invocable Action
+        type: string | nil
+  ExternalConnectivityInvocableActionListRepresentation:
+    description: List of Invocable Actions
+    type: object
+    properties:
+      invocableActions:
+        description: List of Invocable Actions
+        type: array
+        items:
+          type: ExternalConnectivityInvocableActionInfoRepresentation
+
+/external-connectivity:
+  /connections:
+    get:
+      displayName: getExternalConnectivityConnectionList
+      description: GET method to get a list of External Connectivity Connections
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalConnectivityConnectionListRepresentation
+      queryParameters:
+        connectorDeveloperName:
+          type: string
+          required: false
+    post:
+      displayName: postExternalConnectivityConnectionList
+      description: POST method to create External Connectivity Connection
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalConnectivityConnectionCreatedRepresentation
+      body:
+        application/json:
+          type: ExternalConnectivityConnectionInputRepresentation
+          # required: false
+          (oas-body-name): requestBody
+    /delete/{connectionDeveloperName}:
+      post:
+        displayName: postExternalConnectivityConnectionDelete
+        description: POST method to delete External Connectivity Connection
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ExternalConnectivityConnectionEditDeleteResultRepresentation
+      uriParameters:
+        connectionDeveloperName:
+          description: Connection Developer Name
+          type: string
+          required: true
+    /{connectionDeveloperName}:
+      get:
+        displayName: getExternalConnectivityConnectionDetails
+        description: GET method to get External Connectivity Connection Details
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ExternalConnectivityConnectionDetailsRepresentation
+      put:
+        displayName: putExternalConnectivityConnectionDetails
+        description: PUT method to edit External Connectivity Connection
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ExternalConnectivityConnectionEditDeleteResultRepresentation
+        body:
+          application/json:
+            type: ExternalConnectivityConnectionInputRepresentation
+            # required: false
+            (oas-body-name): requestBody
+      uriParameters:
+        connectionDeveloperName:
+          description: Connection Developer Name
+          type: string
+          required: true
+      /referenced-flows:
+        get:
+          displayName: getExternalConnectivityConnectionReferencedFlows
+          description: GET method to get a list of External Connectivity Connection Referenced Flows
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ExternalConnectivityConnectionReferencedFlowsRepresentation
+        uriParameters:
+          connectionDeveloperName:
+            description: Connection Developer Name
+            type: string
+            required: true
+      /refresh-metadata:
+        post:
+          displayName: postExternalConnectivityConnectionRefreshMetadata
+          description: POST method to trigger External Connectivity Connection metadata
+            refresh
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ExternalConnectivityConnectionRefreshMetadataOutputRepresentation
+          body:
+            application/json:
+              type: ExternalConnectivityConnectionRefreshMetadataInputRepresentation
+              # required: false
+              (oas-body-name): requestBody
+        uriParameters:
+          connectionDeveloperName:
+            description: Connection Developer Name
+            type: string
+            required: true
+      /test:
+        post:
+          displayName: postExternalConnectivityConnectionTest
+          description: POST method to test an External Connectivity Connection
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ExternalConnectivityConnectionTestResultRepresentation
+        uriParameters:
+          connectionDeveloperName:
+            description: Connection Developer Name
+            type: string
+            required: true
+  /connectors:
+    get:
+      displayName: getExternalConnectivityConnectorList
+      description: GET method to get a list of External Connectivity Connectors
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalConnectivityConnectorListRepresentation
+  /connectors/{connectorDeveloperName}:
+    get:
+      displayName: getExternalConnectivityConnectorDetails
+      description: GET method to get External Connectivity Connector Details
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalConnectivityConnectorDetailsRepresentation
+    uriParameters:
+      connectorDeveloperName:
+        description: Connector Developer Name
+        type: string
+        required: true
+  /{connectorType}/spa-mapping:
+    get:
+      displayName: getExternalIdentityProvider
+      description: GET method to get the SPA Mappings for the given connector type
+        and version
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IcStandardExternalIdentityProviderListRepresentation
+      queryParameters:
+        version:
+          type: string
+          required: false
+    uriParameters:
+      connectorType:
+        description: Connector Type
+        type: string
+        required: true
+  /invocable-actions:
+    get:
+      displayName: getExternalConnectivityInvocableActionsList
+      description: GET method to get the Invocable Actions for connector type
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExternalConnectivityInvocableActionListRepresentation
+      queryParameters:
+        invocableActionTypes:
+          type: array
+          required: true
+          items:
+            type: string
+            (oas-collectionFormat): csv