@salesforce/lds-adapters-analytics-app-framework 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1503 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  AppActivityCollectionRepresentation:
+    description: Representation for an app's activity or history records.
+    type: object
+    properties:
+      appId:
+        description: The ID or fully qualified API name of the app to which
+          these activities belong.
+        type: string
+      items:
+        description: The collection of app activity records.
+        type: array
+        items:
+          type: AppActivityItemRepresentation
+  AppActivityItemInputRepresentation:
+    description: Input representation for creating an app activity record.
+    type: object
+    properties:
+      activityType:
+        description: The type of application activity.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+      appId:
+        description: The application id.
+        type: string
+      dominoRuntimeRequestId:
+        description: The associated domino runtime request id.
+        type: string
+      id:
+        description: Id of the application activity.
+        type: string
+  AppActivityItemRepresentation:
+    description: Representation for a single app activity record.
+    type: object
+    properties:
+      activityType:
+        description: The type of the app activity item.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+      appId:
+        description: The application id of the activity record.
+        type: string
+      id:
+        description: The ID of the app activity item record.
+        type: string
+      runtimeRequest:
+        description: The associated domino runtime request associated with the app
+          activity item record.
+        # TODO: hand-rolled
+        # DominoRuntimeRequestRepresentation and it's subtypes and related types come from the
+        # json-xform-connect-api modules and are referenced in app-framework-connect-api, which
+        # means they don't get created in this raml. For our usage purposes here currently, we
+        # don't need this type defined and having it as an open-ended object is sufficient.
+        #type: DominoRuntimeRequestRepresentation
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      url:
+        description: The url for the app activity item.
+        type: string
+  AppCollectionRepresentation:
+    description: Representation for Next Gen applications.
+    type: object
+    properties:
+      apps:
+        description: The collection of applications available within this organization.
+        type: array
+        items:
+          type: AppRepresentation
+  AppInputRepresentation:
+    description: Input representation for creating an app from a template.
+    type: object
+    properties:
+      assetIcon:
+        description: The icon enumeration that best represents the new application.
+          Valid values are 1.png through 20.png.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      description:
+        description: The description of the new application.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      label:
+        description: The user-facing name of the new folder or application.
+        type: string
+      logLevel:
+        description: Specifies the runtime logging level for debug.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      name:
+        description: The internal api name of the new application.
+        type: string
+      runtimeMethod:
+        description: The runtime method async or sync
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      templateSourceId:
+        description: Template Id from which to create the app.
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      templateSubtype:
+        description: The subtype of the template this app was created from
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+        enum:
+          - AgentForceAnalytics
+          - Dashboard
+          - DataCloud
+          - SemanticModel
+          - Tableau
+          - Visualization
+      templateType:
+        description: The type of the template this app was created from
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+        enum:
+          - App
+          - Component
+          - Library
+          - Unknown
+      templateValues:
+        description: The runtime template values to use during application creation,
+          as specified by the individual template.
+        type: object
+        required: false # TODO Hand-rolled W-15955585
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      templateVersion:
+        description: The version of the template this app was created from
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      assetIds:
+        description: The asset Ids to associate with the app.
+        required: false # TODO Hand-rolled W-15955585
+        type: array
+        items:
+          type: string
+  AppRepresentation:
+    description: Representation for a single app.
+    type: object
+    properties:
+      activitiesUrl:
+        description: Url to get collection of most recent installation activities
+        type: string
+      applicationStatus:
+        description: The status of this app.
+        type: string
+      assetUrl:
+        description: A link to the App Assets.
+        type: string
+      createdBy:
+        description: Who created this app.
+        type: UserRepresentation
+      createdDate:
+        description: When this app was created.
+        type: string
+      description:
+        description: The description of this app.
+        type: string | nil
+      id:
+        description: The ID or fully qualified API name of this app.
+        type: string
+      installationHistoryUrl:
+        description: A link to the App History Setup Page.
+        type: string
+      label:
+        description: The label of this app.
+        type: string
+      lastModifiedBy:
+        description: Who last modified this app.
+        type: UserRepresentation
+      lastModifiedDate:
+        description: When this app was last modified.
+        type: string
+      latestActivityUrl:
+        description: Url to get the most recent activity.
+        type: string
+      name:
+        description: The dev name of this app.
+        type: string
+      refreshUrl:
+        description: A link to rerun the Data Assets and refresh the data
+        type: string
+      schedule:
+        description: The refresh schedule for this app.
+        type: AppScheduleRepresentation | nil
+      templateSourceId:
+        description: The ID od the template used to create this app.
+        type: string | nil
+      templateSubtype:
+        description: The subtype of the template used to create the app.
+        type: string | nil
+        enum:
+          - AgentForceAnalytics
+          - Dashboard
+          - DataCloud
+          - SemanticModel
+          - Tableau
+          - Visualization
+      templateType:
+        description: The type of the template used to create the app.
+        type: string
+        enum:
+          - App
+          - Component
+          - Library
+          - Unknown
+      templateValues:
+        description: The Variable Values (Answers to Questions) used to customize
+          the app install.
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+      templateVersion:
+        description: The version of the template used to create the app.
+        type: string | nil
+      url:
+        description: A self link to this App
+        type: string
+  AppResultRepresentation:
+    description: Representation for the results of an app creation.
+    type: object
+    properties:
+      app:
+        description: The App.
+        type: AppRepresentation
+      failureMessage:
+        description: The Failure message if the app has failed. If this app was created
+          Async it may not have completed yet.
+        type: string | nil
+      runtimeRequestId:
+        description: The Domino Runtime Request.
+        type: string | nil
+      state:
+        description: The State.
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+  AppScheduleRepresentation:
+    description: Representaiton for an App Data Refresh schedule
+    type: object
+    properties:
+      dataRefreshSchedule:
+        description: Recurring schedule for performing data refreshes.
+        type: ScheduledItemRepresentation | nil
+      url:
+        description: Url to scheduling attributes of a folder.
+        type: string | nil
+  AppUpdateRepresentation:
+    description: Input representation for updating/reconfiguring an app from a template.
+    type: object
+    properties:
+      logLevel:
+        description: Specifies the runtime logging level for debug.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      runtimeMethod:
+        description: The runtime method async or sync
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      templateSourceId:
+        description: Template Id from which the app was created from.
+        type: string
+      templateValues:
+        description: The runtime template values to use during application upgrade
+        required: false # TODO Hand-rolled W-15955585
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+  AssetCollectionRepresentation:
+    description: Representation list of assets created from a template.
+    type: object
+    properties:
+      appId:
+        description: The ID or fully qualified API name of the app to which these
+          assets belong.
+        type: string
+      assets:
+        description: The collection of assets created from the template.
+        type: array
+        items:
+          type: AssetRepresentation
+  AssetInputRepresentation:
+    description: Input representation for creating library assets from a template.
+    type: object
+    properties:
+      appId:
+        description: App Id this asset belongs to
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      assetIdOrName1:
+        description: Primary Id or devname of the asset
+        type: string
+      assetIdOrName2:
+        description: Secondary Id or devname of the asset
+        type: string | nil
+        required: false # TODO Hand-rolled W-15955585
+      assetIdOrName3:
+        description: tertiary Id or devname of the asset.
+        type: string | nil
+        required: false # TODO Hand-rolled W-15955585
+      templateAssetSourceName:
+        description: Template Asset name associated with this asset
+        type: string | nil
+        required: false # TODO Hand-rolled W-15955585
+      templateSourceId:
+        description: App or Component Template Id where this asset was created from
+        type: string | nil
+        required: false # TODO Hand-rolled W-15955585
+      type:
+        description: Asset Type
+        type: string | nil
+        required: false # TODO Hand-rolled W-15955585
+  AssetRepresentation:
+    description: Representation for a single template.
+    type: object
+    properties:
+      appId:
+        description: The App ID associated with this
+        type: string
+      assetIdOrName:
+        description: The primary ID or Name of the asset
+        type: string
+      assetIdOrName2:
+        description: The secondary ID or Name of the asset
+        type: string | nil
+      assetIdOrName3:
+        description: The tertiary ID or Name of the asset
+        type: string | nil
+      id:
+        description: The ID of the asset association.
+        type: string
+      templateAssetSourceName:
+        description: The template asset name this asset was created from.
+        type: string | nil
+      templateSourceId:
+        description: The template this asset was created from
+        type: string | nil
+      type:
+        description: The asset type.
+        type: string | nil
+  BasicAppUpdateRepresentation:
+    description: Input representation for updating a basic app from a list of asset ids.
+    type: object
+    properties:
+      assetIds:
+        description: The asset Ids to associate with the app.
+        type: array
+        items:
+          type: string
+  ChainDefinitionInputRepresentation:
+    description: Input representation for a domino chain definition.
+    type: object
+    properties:
+      file:
+        description: The this file reference to the chain
+        type: string
+      name:
+        description: The name of the chain.
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      type:
+        description: The type of chain.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - RefreshData
+          - Update
+  ChainDefinitionRepresentation:
+    description: chain definition.
+    type: object
+    properties:
+      dominoChainId:
+        description: The domino chain id.
+        type: string | nil
+      file:
+        description: The file.
+        type: string
+      name:
+        description: The name.
+        type: string | nil
+      type:
+        description: The chain type.
+        type: string
+        enum:
+          - Create
+          - Delete
+          - OrgReadiness
+          - RefreshData
+          - Update
+  InstalledAssetCollectionRepresentation:
+    description: Representation list of assets associated with an app
+    type: object
+    properties:
+      assets:
+        description: The collection of assets associated with an app - may or may
+          not be created from template
+        type: array
+        items:
+          type: AssetRepresentation
+  ReleaseInfoInputRepresentation:
+    description: Input representation for release notes and version.
+    type: object
+    properties:
+      notesFile:
+        description: Template release notes.
+        type: string
+        required: false # TODO Hand-rolled W-15955585
+      templateVersion:
+        description: Template version.
+        type: string
+  ReleaseInfoRepresentation:
+    description: release info.
+    type: object
+    properties:
+      notesFile:
+        description: The notes file of this template.
+        type: string | nil
+      templateVersion:
+        description: The template version of this template.
+        type: string
+  RuleInfoInputRepresentation:
+    description: Input representation for rules.
+    type: object
+    properties:
+      file:
+        description: The JSON file holding the rules.
+        type: string
+      type:
+        description: The type of rules.
+        type: string
+  RuleInfoRepresentation:
+    description: output representation for rules.
+    type: object
+    properties:
+      file:
+        description: The file.
+        type: string
+      type:
+        description: The rule type.
+        type: string
+  TemplateCollectionRepresentation:
+    description: Representation for Next Gen application templates.
+    type: object
+    properties:
+      templates:
+        description: The collection of application templates available within this
+          organization.
+        type: array
+        items:
+          type: TemplateRepresentation
+  TemplateConfigurationRepresentation:
+    description: Representation for app template configuration.
+    type: object
+    properties:
+      id:
+        description: The ID or fully qualified API name of this template.
+        type: string
+      layout:
+        description: The layout interface definition for the template.
+        type: UiLayoutDefinitionRepresentation | nil
+      name:
+        description: The local API name of the template.
+        type: string
+      variables:
+        description: The defined set of variables for this Wave template.
+        type: object
+        properties:
+          //:
+            # Setting this to the real type causes the snapshot to reject with:
+            # 'Invalid resource response. Expected resource response to result in Fulfilled or Stale snapshot'
+            # (with no errors about the type, even on empty {} value). Using type: any gets past it for now.
+            type: any # TODO Hand-rolled W-8863405
+            #type: VariableDefinitionRepresentation
+  TemplateIconsInputRepresentation:
+    description: Input representation template Icons.
+    type: object
+    properties:
+      appBadge:
+        description: Icon for the app.
+        type: TemplateImageInputRepresentation
+      templateBadge:
+        description: Icon for the template
+        type: TemplateImageInputRepresentation
+      templatePreviews:
+        description: Previews images an description of template
+        type: array
+        items:
+          type: TemplateImageInputRepresentation
+  TemplateIconsRepresentation:
+    description: template icons.
+    type: object
+    properties:
+      appBadge:
+        description: The app badge.
+        type: TemplateImageRepresentation | nil
+      templateBadge:
+        description: The template badge.
+        type: TemplateImageRepresentation | nil
+      templatePreviews:
+        description: The template previews.
+        type: array
+        items:
+          type: TemplateImageRepresentation
+  TemplateImageInputRepresentation:
+    description: Input representation for Template Images.
+    type: object
+    properties:
+      file:
+        description: Image file
+        type: string
+      name:
+        description: Image Name.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+  TemplateImageRepresentation:
+    description: Template image representation.
+    type: object
+    properties:
+      file:
+        description: The file that qualifies the image
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      name:
+        description: The image name.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      url:
+        description: The image URL.
+        type: string
+  TemplateInputRepresentation:
+    description: Input representation for Template Info.
+    type: object
+    properties:
+      applicationSourceId:
+        description: The Template application source
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      assetVersion:
+        description: The version of the Template assets.
+        required: false # TODO Hand-rolled W-15955585
+        type: number
+      chainDefinitions:
+        description: The Template chain definitions
+        required: false # TODO Hand-rolled W-15955585
+        type: array
+        items:
+          type: ChainDefinitionInputRepresentation
+      description:
+        description: The Template description.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      icons:
+        description: The Template icons.
+        required: false # TODO Hand-rolled W-15955585
+        type: TemplateIconsInputRepresentation
+      id:
+        description: The Template Id.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      label:
+        description: The Template label.
+        type: string
+      layoutDefinition:
+        description: The Template layout definition file.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      maxAppCount:
+        description: The maximum number of apps that can be creatd from this template.
+        required: false # TODO Hand-rolled W-15955585
+        type: integer
+      name:
+        description: The Template name.
+        type: string
+      namespace:
+        description: The Template developer namespace.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      releaseInfo:
+        description: The Template release notes
+        required: false # TODO Hand-rolled W-15955585
+        type: ReleaseInfoInputRepresentation
+      rules:
+        description: The Template rules file
+        type: array
+        required: false # TODO Hand-rolled W-15955585
+        items:
+          type: RuleInfoInputRepresentation
+      tags:
+        description: The Template Tags.
+        required: false # TODO Hand-rolled W-15955585
+        type: object
+        properties:
+          //:
+            type: any
+      templateSubtype:
+        description: The Template Subtype.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+        enum:
+          - AgentForceAnalytics
+          - Dashboard
+          - DataCloud
+          - SemanticModel
+          - Tableau
+          - Visualization
+      templateType:
+        description: The Template Type.
+        type: string
+        enum:
+          - App
+          - Component
+          - Library
+          - Unknown
+      variableDefinition:
+        description: The Template variables file
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+  TemplateReadinessInputRepresentation:
+    description: Input representation for performing org readiness check on a template
+    type: object
+    properties:
+      logLevel:
+        description: Specifies the runtime logging level for debug.
+        required: false
+        type: string
+      templateValues:
+        description: The runtime template values user to control conditions in the
+          chain.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8863405
+            #type: object
+  TemplateReadinessItemRepresentation:
+    description: Results for individual validation task
+    type: object
+    properties:
+      message:
+        description: The task specific message.
+        type: string | nil
+      readinessStatus:
+        description: The status for the readiness task
+        type: string | nil
+        enum:
+          - Complete
+          - Failed
+          - Warning
+      tags:
+        description: The collection of tags describing the purpose of the validation.
+        type: array
+        items:
+          type: string
+      type:
+        description: The task specific type, associated with readiness check type.
+        type: string
+  TemplateReadinessRepresentation:
+    description: Representation for app template readiness check.
+    type: object
+    properties:
+      id:
+        description: The Template Id this readiness check was performed on
+        type: string
+      runtimeRequestId:
+        description: The Domino Runtime Request.
+        type: string | nil
+      state:
+        description: The State information
+        type: object
+        properties:
+          //:
+            type: any # TODO: Hand-rolled W-8863405
+            #type: object
+      status:
+        description: The Status
+        type: string
+      tasks:
+        description: Results from each requirement task.
+        type: array
+        items:
+          type: TemplateReadinessItemRepresentation
+      warningMessage:
+        description: Warning message (readiness chain not found).
+        type: string | nil
+  TemplateRepresentation:
+    description: Representation for a single template.
+    type: object
+    properties:
+      applicationSourceId:
+        description: The ID of the application source for this template.
+        type: string | nil
+      assetVersion:
+        description: The asset version of the application template.
+        type: number | nil
+      chainDefinitions:
+        description: The chain definitions.
+        type: array
+        items:
+          type: ChainDefinitionRepresentation
+      configurationUrl:
+        description: Url for configuration information
+        type: string
+      createdDate:
+        description: The created date of the application Template.
+        type: string | nil
+      description:
+        description: The description of the application template.
+        type: string | nil
+      icons:
+        description: The icons of the application template.
+        type: TemplateIconsRepresentation | nil
+      id:
+        description: The ID or fully qualified API name of this template.
+        type: string
+      label:
+        description: The localized name of the application template.
+        type: string
+      lastModifiedDate:
+        description: The last modified date of the application Template.
+        type: string | nil
+      layoutDefinition:
+        description: The layout definition of the application template.
+        type: string | nil
+      maxAppCount:
+        description: The max app count of the application template.
+        type: integer | nil
+      name:
+        description: The local API name of the application template.
+        type: string
+      namespace:
+        description: The local namespace of the application template.
+        type: string | nil
+      readinessUrl:
+        description: Url for performing org readiness check
+        type: string
+      releaseInfo:
+        description: The release info of the application template.
+        type: ReleaseInfoRepresentation | nil
+      rules:
+        description: The rules.
+        type: array
+        items:
+          type: RuleInfoRepresentation
+      tags:
+        description: The Template Tags.
+        type: object
+        properties:
+          //:
+            type: any
+      templateSubtype:
+        description: The template sub type.
+        type: string | nil
+        enum:
+          - AgentForceAnalytics
+          - Dashboard
+          - DataCloud
+          - SemanticModel
+          - Tableau
+          - Visualization
+      templateType:
+        description: The template type.
+        type: string
+        enum:
+          - App
+          - Component
+          - Library
+          - Unknown
+      url:
+        description: The this url.
+        type: string
+      variableDefinition:
+        description: The variable definition of the application template.
+        type: string | nil
+      templateStatus:
+        description: The Template Status
+        type: string | nil
+        enum:
+          - Draft
+          - Published
+  UserRepresentation:
+    description: Information about a user.
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID.
+        type: string
+      name:
+        description: The name of the user.
+        type: string
+      profilePhotoUrl:
+        description: The Chatter profile photo of the user.
+        type: string | nil
+  # TODO: hand-rolled
+  # ScheduleItemReresentation and its subtypes and related types come from the json-xform-connect-api
+  # module and are referenced in app-framework-connect-api. This means they don't get created in the
+  # app-framework-connect-api raml, so I'm copying them from the json-xform-connect-api raml here.
+  DailyScheduledItemRepresentation:
+    description: Representation for a scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Daily
+    properties: {}
+  HourlyScheduledItemRepresentation:
+    description: Representation for an hourly scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Hourly
+    properties:
+      daysOfWeek:
+        description: Collection of days of week for schedule.
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
+      hourlyInterval:
+        description: Collection of days of week for schedule.
+        type: integer
+  ScheduledItemRepresentation:
+    description: Representation for a scheduled item.
+    type: object
+    discriminator: frequency
+    properties:
+      frequency:
+        description: The frequency of this scheduled item.
+        type: string
+        enum:
+          - Daily
+          - Hourly
+          - Weekly
+        # TODO: hand-rolled -- these are in the java enum, but do not have corresponding java
+        # subclasses so they won't be seen in responses for now
+        # - Monthly
+        # - MonthlyRelative
+      nextScheduledRun:
+        description: The next scheduled runtime.
+        type: string
+      time:
+        description: Collection of scheduled run time.
+        type: ScheduledTimeRepresentation
+  ScheduledTimeRepresentation:
+    description: Representation for a scheduled time of day.
+    type: object
+    properties:
+      hour:
+        description: Hour of day.
+        type: integer
+      minute:
+        description: Minute of hour.
+        type: integer
+      timezone:
+        description: String representation of timezone.
+        type: ScheduledTimezoneRepresentation
+  ScheduledTimezoneRepresentation:
+    description: Information about a time zone.
+    type: object
+    properties:
+      gmtOffset:
+        description: The signed offset, in hours, from GMT.
+        format: double
+        type: number
+      name:
+        description: The display name of this time zone.
+        type: string
+      zoneId:
+        description: The zone ID of this time zone.
+        type: string
+  WeeklyScheduledItemRepresentation:
+    description: Representation for a daily scheduled item.
+    type: ScheduledItemRepresentation
+    discriminatorValue: Weekly
+    properties:
+      daysOfWeek:
+        description: Collection of days of week for schedule.
+        type: array
+        items:
+          type: string
+          enum:
+            - Friday
+            - Monday
+            - Saturday
+            - Sunday
+            - Thursday
+            - Tuesday
+            - Wednesday
+  TemplateTagCollectionInputRepresentation:
+    description: Input representation for creating template tag records.
+    type: object
+    properties:
+      tags:
+        description: The Template Tags.
+        required: false # TODO Hand-rolled W-15955585
+        type: object
+        properties:
+          //:
+            type: any
+  TemplateTagCollectionRepresentation:
+    description: Representation for template tag records.
+    type: object
+    properties:
+      tags:
+        description: The collection of template tag records.
+        type: object
+        properties:
+          //:
+            type: any
+      templateId:
+        description: The id for the tags' template.
+        type: string
+  TemplateUpdateRepresentation:
+    description: Input representation for Template update.
+    type: object
+    properties:
+      applicationSourceId:
+        description: The Template application source
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      description:
+        description: The Template description.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      releaseInfo:
+        description: The Template release notes
+        required: false # TODO Hand-rolled W-15955585
+        type: ReleaseInfoInputRepresentation
+      label:
+        description: The Template label.
+        required: false # TODO Hand-rolled W-15955585
+        type: string
+      templateStatus:
+        description: The Template Status
+        required: false
+        type: string
+        enum:
+          - Draft
+          - Published
+  TemplatedAssetCollectionRepresentation:
+    description: Representation for Next Gen application templated assets.
+    type: object
+    properties:
+      templatedAssets:
+        description: The collection of templated assets available.
+        type: array
+        items:
+          type: TemplatedAssetRepresentation
+  TemplatedAssetRepresentation:
+    description: A templated asset
+    type: object
+    properties:
+      assetType:
+        description: The asset type
+        type: string
+      body:
+        description: The templated asset's body
+        type: string | nil
+      fileName:
+        description: The templated asset's file name
+        type: string | nil
+      id:
+        description: The templated asset's id
+        type: string
+      templateId:
+        description: The id for the asset's template
+        type: string
+      templatedAssetName:
+        description: The asset's name within the template'
+        type: string
+  UiLayoutDefinitionRepresentation:
+    description: Representation for UI definition of Wave templates with layout support.
+    type: object
+    properties:
+      appDetails:
+        description: Configuration for the app details page of the wizard.
+        required: false # TODO Hand-rolled W-8253396
+        type: AppDetailsRepresentation
+      displayMessages:
+        description: The display messages for this template configuration.
+        type: array
+        items:
+          type: any # TODO Hand-rolled W-8863405 should be DisplayMessageRepresentation
+      navigationPanel:
+        description: Configuration for the navigation panel of the wizard.
+        type: NavigationPanelRepresentation
+        required: false # TODO Hand-rolled W-8253396
+      pages:
+        description: The page collection for this template configuration.
+        type: array
+        items:
+          # Setting this to the real type causes the snapshot to reject with:
+          # 'Invalid discriminator. Expected discriminator at path
+          # "layout.pages.type" but receive [...]' where [...] is the
+          # layout.pages array (it should be looking at one of the elements of
+          # that array, not the array itself). Using any for now to get past
+          # this.
+          type: any # TODO Hand-rolled W-8863405 should be PageLayoutRepresentation
+  AppDetailsRepresentation:
+    description: Configuration for the app details page in the wizard
+    type: object
+    properties:
+      guidancePanel:
+        description: The guidance panel to show on the app details page.
+        required: false # TODO Hand-rolled W-8253396
+        type: GuidancePanelRepresentation
+      navigation:
+        description: The navigation info for this page in the navigation panel.
+        required: false # TODO Hand-rolled W-8253396
+        type: PageNavigationInfoRepresentation
+  GuidancePanelRepresentation:
+    description: Configuration for the guidance panel on wizard pages
+    type: object
+    properties:
+      backgroundImage:
+        description: The optional background image for the guidance panel
+        required: false # TODO Hand-rolled W-8253396
+        type: ImageReferenceRepresentation
+      items:
+        description: The items to display in the guidance panel.
+        type: array
+        items:
+          type: any # TODO Hand-rolled W-8863405 should be PanelItemRepresentation
+      title:
+        description: The top title for the guidance panel.
+        type: string | nil
+  PageNavigationInfoRepresentation:
+    description: Configuration for how a page appears in the navigation panel
+    type: object
+    properties:
+      label:
+        description: The label to display for the pane in the navigation panel.
+        required: false # TODO Hand-rolled W-8253396
+        type: string
+      parentLabel:
+        description: The label for the parent node of this page  in the navigation
+          panel.
+        required: false # TODO Hand-rolled W-8253396
+        type: string
+  NavigationPanelRepresentation:
+    description: Configuration for the navigation panel in the wizard
+    type: object
+    properties:
+      title:
+        description: The title to display in the pane.
+        type: string
+  ImageReferenceRepresentation:
+    description: Image reference representation.
+    type: object # TODO Hand-rolled W-8988532 due to StaticResourceReferenceRepresentation requiring a discriminator but generated raml does not have one issue
+    #type: StaticResourceReferenceRepresentation
+    # Both ImageReferenceRepresentation and TemplatePreviewRepresentation inherits from StaticResourceReferenceRepresentation but TemplatePreviewRepresentation
+    # has more properties. The generated raml cannot distinguish between the two types without a discriminator value so the properties are copied over.
+    properties:
+      id:
+        required: false # TODO Hand-rolled W-8253396
+        description: The 18 character ID of the asset.
+        type: string
+      label:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset label.
+        type: string
+      name:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset developer name.
+        type: string
+      namespace:
+        required: false # TODO Hand-rolled W-8253396
+        description: The namespace that qualifies the asset name
+        type: string
+      url:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset URL.
+        type: string
+  StaticResourceReferenceRepresentation:
+    description: Static Resource reference representation.
+    type: object
+    properties:
+      id:
+        required: false # TODO Hand-rolled W-8253396
+        description: The 18 character ID of the asset.
+        type: string
+      label:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset label.
+        type: string
+      name:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset developer name.
+        type: string
+      namespace:
+        required: false # TODO Hand-rolled W-8253396
+        description: The namespace that qualifies the asset name
+        type: string
+      url:
+        required: false # TODO Hand-rolled W-8253396
+        description: The asset URL.
+        type: string
+/app-framework:
+  /apps:
+    get:
+      displayName: getAppFrameworkAppCollection
+      description: Get a list of applications
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppCollectionRepresentation
+      queryParameters:
+        templateSourceId:
+          type: string
+          required: false
+        templateSubtype:
+          type: string
+          required: false
+          enum:
+            - AgentForceAnalytics
+            - Dashboard
+            - DataCloud
+            - SemanticModel
+            - Tableau
+            - Visualization
+        type:
+          type: string
+          required: false
+          enum:
+            - App
+            - Component
+            - Library
+            - Unknown
+    post:
+      displayName: postAppFrameworkAppCollection
+      description: Creates an app from a template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppResultRepresentation
+      body:
+        application/json:
+          type: AppInputRepresentation
+          (oas-body-name): app
+  /apps/{appIdOrApiName}:
+    delete:
+      displayName: deleteAppFrameworkApp
+      description: Delete an App.
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getAppFrameworkApp
+      description: Get an App
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppRepresentation
+    put:
+      displayName: putAppFrameworkApp
+      description: Update an app from a template.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppResultRepresentation
+      body:
+        application/json:
+          # TODO: Hand-rolled due to issue #24 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          type: AppUpdateRepresentation
+          (oas-body-name): updateBody
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+  /apps/{appIdOrApiName}/activities:
+    get:
+      displayName: getAppFrameworkAppActivityCollection
+      description: Get a list of app activity records
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppActivityCollectionRepresentation
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+    /{id}:
+      get:
+        displayName: getAppFrameworkAppActivityItem
+        description: Get a specific App's activity
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AppActivityItemRepresentation
+      uriParameters:
+        appIdOrApiName:
+          type: string
+          required: true
+        id:
+          type: string
+          required: true
+  /apps/{appIdOrApiName}/assets:
+    get:
+      displayName: getAppFrameworkAppAssetCollection
+      description: Get a list of assets included in the app
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AssetCollectionRepresentation
+      queryParameters:
+        assetType:
+          type: string
+          required: false
+        templateAssetName:
+          type: string
+          required: false
+    post:
+      displayName: postAppFrameworkAppAsset
+      description: Add an asset included in the app
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AssetRepresentation
+      body:
+        application/json:
+          type: AssetInputRepresentation
+          (oas-body-name): appAssetParam
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+    /{appAssetId}:
+      get:
+        displayName: getAppFrameworkAppAsset
+        description: Get an app's specific asset
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AssetRepresentation
+      delete:
+        displayName: deleteAppFrameworkAppAsset
+        description: Delete an App Asset
+        responses:
+          '200':
+            description: Success
+      patch:
+        displayName: patchAppFrameworkAppAsset
+        description: Update an app's specific resource.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AssetRepresentation
+        body:
+          application/json:
+            type: AssetInputRepresentation
+            (oas-body-name): appAssetParam
+      uriParameters:
+        appIdOrApiName:
+          type: string
+          required: true
+        appAssetId:
+          type: string
+          required: true
+  /apps/{appIdOrApiName}/updateBasicApp:
+    post:
+      displayName: postAppFrameworkBasicApp
+      description: Update this app with a list of resources, nor from a template.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AppResultRepresentation
+      body:
+        application/json:
+          type: BasicAppUpdateRepresentation
+          (oas-body-name): updateBody
+    uriParameters:
+      appIdOrApiName:
+        type: string
+        required: true
+  /installed-assets:
+    get:
+      displayName: getAppFrameworkInstalledAssetCollection
+      description: Get a list of assets installed by a template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: InstalledAssetCollectionRepresentation
+      queryParameters:
+        assetIdOrName:
+          type: string
+          required: false
+        assetType:
+          type: string
+          required: false
+  /templates:
+    get:
+      displayName: getAppFrameworkTemplateCollection
+      description: Get a list of application templates
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateCollectionRepresentation
+      queryParameters:
+        templateSubtype:
+          type: string
+          required: false
+          enum:
+            - AgentForceAnalytics
+            - Dashboard
+            - DataCloud
+            - SemanticModel
+            - Tableau
+            - Visualization
+        type:
+          type: string
+          required: false
+          enum:
+            - App
+            - Component
+            - Library
+            - Unknown
+    post:
+      displayName: postAppFrameworkTemplateCollection
+      description: Create a new application template.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateRepresentation
+      body:
+        application/json:
+          type: TemplateInputRepresentation
+          (oas-body-name): templateParam
+  /templates/{templateIdOrApiName}:
+    get:
+      displayName: getAppFrameworkTemplate
+      description: Get an App Template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateRepresentation
+    patch:
+      displayName: patchAppFrameworkTemplate
+      description: Update a Template resource.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateRepresentation
+      body:
+        application/json:
+          type: TemplateUpdateRepresentation
+          (oas-body-name): templateParam
+    delete:
+      displayName: deleteAppFrameworkTemplate
+      description: Delete a Template.
+      responses:
+        '200':
+          description: Success
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true
+  /templates/{templateIdOrApiName}/assets:
+    get:
+      displayName: getAppFrameworkTemplateAssetCollection
+      description: Get a list of assets associated with a template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplatedAssetCollectionRepresentation
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true
+  /templates/{templateIdOrApiName}/configuration:
+    get:
+      displayName: getAppFrameworkTemplateConfiguration
+      description: Returns the configuration for a specific template.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateConfigurationRepresentation
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true
+  /templates/{templateIdOrApiName}/readiness:
+    post:
+      displayName: postAppFrameworkTemplateReadiness
+      description: Validate an application template for org readiness.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateReadinessRepresentation
+      body:
+        application/json:
+          type: TemplateReadinessInputRepresentation
+          (oas-body-name): templateReadinessParam
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true
+  /templates/{templateIdOrApiName}/tags:
+    get:
+      displayName: getAppFrameworkTemplateTagCollection
+      description: Get a list of template tag records
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateTagCollectionRepresentation
+    put:
+      displayName: putAppFrameworkTemplateTagCollection
+      description: Upsert template tags.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateTagCollectionRepresentation
+      body:
+        application/json:
+          type: TemplateTagCollectionInputRepresentation
+          (oas-body-name): templateTagParam
+    uriParameters:
+      templateIdOrApiName:
+        type: string
+        required: true