@salesforce/lds-adapters-platform-data-seed 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,898 @@
+#%RAML 1.0
+title: Salesforce API Platform Cloudbeat
+protocols:
+  - HTTPS
+types:
+  DataSeedStatusOutputRepresentation:
+    description: Data Seed Response Representation
+    type: object
+    properties:
+      data:
+        description: Data Seed Request's History Data List
+        type: array
+        items:
+          type: DataSeedRequestObjectRepresentation
+      correlation_id:
+        description: Data Seed Request's Correlation ID
+        type: string
+  DataSeedRequestStatusOutputRepresentation:
+    description: Data Seed Request Response Representation
+    type: object
+    properties:
+      data:
+        description: Data Seed Request's Details Object
+        type: DataSeedRequestObjectRepresentation
+      correlation_id:
+        description: Correlation Id For This Request
+        type: string
+  DataSeedRequestObjectRepresentation:
+    description: Data Seed Request properties
+    type: object
+    properties:
+      request_id:
+        description: Request ID
+        type: string
+      organization_id:
+        description: Organization ID
+        type: string
+      name:
+        description: Request Name
+        type: string
+      description:
+        description: Request Description
+        type: string
+      job_type:
+        description: Request Job Type
+        type: string
+      status:
+        description: Request Status
+        type: string
+      step:
+        description: Request Step
+        type: string
+      log_text:
+        description: Request Log Text
+        type: string
+      execution_start_time:
+        description: Request Execution Start Time
+        type: string
+      execution_end_time:
+        description: Request Execution End Time
+        type: string
+      created_by:
+        description: Request Created By User
+        type: string
+      source_organization_id:
+        description: Source Org Id
+        type: string
+      target_organization_id:
+        description: Target Org Id
+        type: string
+  DataSeedStatusErrorRepresentation:
+    description: Data Seed Error Representation
+    type: object
+    properties:
+      error:
+        description: Data Seed Error Message
+        type: string
+  PreSignedUrlInputRepresentation:
+    description: Pre Signed Url Input Representation
+    type: object
+    properties:
+      file_name:
+        description: File Name
+        type: string
+  PreSignedUrlResultRepresentation:
+    description: Pre Signed Url Response Representation
+    type: object
+    properties:
+      url:
+        description: Pre Signed Url
+        type: string
+      s3_unique_id:
+        description: Url Unique Id
+        type: string
+  PreSignedDownloadUrlResultRepresentation:
+    description: Pre Signed Url Response Representation
+    type: object
+    properties:
+      url:
+        description: Pre Signed Url
+        type: string
+      correlation_id:
+        description: Correlation id of request
+        type: string
+  PreSignedUrlBadErrorRepresentation:
+    description: Pre Signed Url Missing Parameters Error Representation
+    type: object
+    properties:
+      error:
+        description: Pre Signed Url Bad Request Error Message
+        type: string
+  PreSignedUrlServerErrorRepresentation:
+    description: Pre Signed Url Server Error Representation
+    type: object
+    properties:
+      error:
+        description: Pre Signed Url Server Error Message
+        type: string
+      correlation_id:
+        description: Pre Signed Url Request Correlation Id
+        type: string
+  EntityResponseObject:
+    description: Entity Response Object
+    type: object
+    properties:
+      objectAPIName:
+        description: Entity API Name
+        type: string
+      objectName:
+        description: Entity Name
+        type: string
+      type:
+        description: Entity Type
+        type: string
+  EntitiesOutputRepresentation:
+    description: List of entities
+    type: object
+    properties:
+      entities:
+        description: List of entities details
+        type: array
+        items:
+          type: EntityResponseObject
+      correlation_id:
+        description: Entity Details Request Correlation Id
+        type: string
+  OrgEntitiesInputRepresentation:
+    description: Org Entities Payload
+    type: object
+    properties:
+      source_instance_url:
+        description: Source Instance Url
+        type: string
+      source_access_token:
+        description: Source Access Token
+        type: string
+  MigrateDataOutputRepresentation:
+    description: Data Migration Response
+    type: object
+    properties:
+      correlation_id:
+        description: Data Migrate Correlation Id
+        type: string
+      response:
+        description: Data Migrate Response
+        type: string
+      request_id:
+        description: Data Migrate Request Id
+        type: string
+  MigrateDataInputRepresentation:
+    description: Migrate Data Payload
+    type: object
+    properties:
+      source_instance_url:
+        description: Source Instance Url
+        type: string
+        required: true
+      source_access_token:
+        description: Source Access Token
+        type: string
+        required: true
+      target_instance_url:
+        description: Target Instance Url
+        type: string
+        required: true
+      target_access_token:
+        description: Target Access Token
+        type: string
+        required: true
+      name:
+        description: Data Seed Name
+        type: string
+        required: true
+      desc:
+        description: Data Seed Description
+        type: string
+      config:
+        description: Data Seed Config
+        type: string
+      mode:
+        description: Data Seed Model
+        type: string
+  LoadDataInputRepresentation:
+    description: Load Data Payload
+    type: object
+    properties:
+      target_instance_url:
+        description: Target Instance Url
+        type: string
+        required: true
+      target_access_token:
+        description: Target Access Token
+        type: string
+        required: true
+      operation_type:
+        description: Request Operation Type
+        type: string
+        required: false
+  AuthCallbackStatusRepresentation:
+    description: Response structure for successfully retrieving callback status.
+    type: object
+    properties:
+      correlation_id:
+        description: Correlation ID for the request.
+        type: string
+      callback_id:
+        description: Unique callback ID.
+        type: string
+      organization_id:
+        description: The organization ID associated with the callback.
+        type: string
+      auth_code:
+        description: Authorization code received during the callback.
+        type: string
+      org_url:
+        description: The instance URL for the organization.
+        type: string
+      access_token:
+        description: The access token received from the callback.
+        type: string
+  EntitiesDetailsInputRepresentation:
+    description: Org Entities Details Payload
+    type: object
+    properties:
+      source_instance_url:
+        description: Source Instance Url
+        type: string
+      source_access_token:
+        description: Source Access Token
+        type: string
+      object_names:
+        description: Object Names
+        type: array
+        items:
+          type: string
+  EntitiesDetailsOutputRepresentation:
+    description: List of entities
+    type: object
+    properties:
+      metadata:
+        description: Entity Details Response List
+        type: array
+        items:
+          type: EntityDetailsResponseObject
+      correlation_id:
+        description: Request Correlation Id
+        type: string
+  EntityDetailsResponseObject:
+    description: Entity Details Response object
+    type: object
+    properties:
+      childRelationships?:
+        description: List of Related Objects
+        type: array
+        items:
+          type: EntityDetailsChildResponseObject
+      parentRelationships?:
+        description: List of Related Objects
+        type: array
+        items:
+          type: EntityDetailsParentResponseObject
+      fields?:
+        description: Fields List
+        type: array
+        items:
+          type: EntityDetailsFieldsResponseObject
+      objectAPIName?:
+        description: Object API Name
+        type: string
+      objectIcon?:
+        description: Object Icon URL
+        type: string
+      objectLabel?:
+        description: Object Label
+        type: string
+      recordCount?:
+        description: Object Record Count
+        type: number
+      type?:
+        description: Object Type
+        type: string
+      error?:
+        description: Error message if applicable
+        type: string
+      objectName?:
+        description: Name of the object causing the error (optional)
+        type: string
+  EntityDetailsChildResponseObject:
+    description: Child relationships of the entity
+    type: object
+    properties:
+      childObjectLabel?:
+        description: Label of the related entity
+        type: string
+      childObjectName?:
+        description: Name of the related entity
+        type: string
+      childObjectRelationshipField?:
+        description: Name of the relationship
+        type: string
+      childObjectType?:
+        description: Child object type
+        type: string
+  EntityDetailsParentResponseObject:
+    description: Parent relationships of the entity
+    type: object
+    properties:
+      parentObjectLabel?:
+        description: Label of the parent entity
+        type: string
+      parentObjectName?:
+        description: Name of the parent entity
+        type: string
+      parentObjectRelationshipField?:
+        description: Name of the relationship
+        type: string
+      parentObjectType?:
+        description: Parent object type
+        type: string
+
+  EntityDetailsFieldsResponseObject:
+    description: Details about a field in the entity
+    type: object
+    properties:
+      dataType?:
+        description: Data type of the field
+        type: string
+      fieldLabel?:
+        description: Label of the field
+        type: string
+      fieldName?:
+        description: Name of the field
+        type: string
+      picklistValues?:
+        description: List of picklist values (optional)
+        type: array
+        items:
+          type: PicklistValueObject
+  PicklistValueObject:
+    description: Picklist value details
+    type: object
+    properties:
+      active?:
+        description: Indicates if the picklist value is active
+        type: boolean
+      defaultValue?:
+        description: Indicates if the value is the default
+        type: boolean
+      label?:
+        description: Label of the picklist value
+        type: string | nil
+      validFor?:
+        description: Additional valid options for the value (optional)
+        type: string | nil
+      value?:
+        description: The picklist value
+        type: string | nil
+  OrgDetailsRepresentation:
+    description: Salesforce Organization Details Response
+    type: object
+    properties:
+      correlation_id:
+        type: string
+        description: Unique identifier for tracking the request
+      org_details:
+        type: OrgDetailsObjectRepresentation
+  OrgDetailsObjectRepresentation:
+    description: Salesforce Organization Details Response
+    type: object
+    properties:
+      org_id:
+        type: string
+        description: Salesforce Organization ID
+      org_name:
+        type: string
+        description: Name of the Salesforce organization
+      is_sandbox:
+        type: boolean
+        description: Indicates if the organization is a sandbox
+      organization_type:
+        type: string
+        description: Type of the Salesforce organization
+  OrgDetailsErrorRepresentation:
+    description: Error Response for Org Details API
+    type: object
+    properties:
+      correlation_id:
+        type: string
+        description: Unique identifier for tracking the request
+      error:
+        type: string
+        description: Error message describing the issue
+/platform/data-seed/v1:
+  /data-seed-request:
+    get:
+      displayName: DataSeedStatusAPI
+      description: Return List of All Requests
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with request's status.
+          body:
+            application/json:
+              type: DataSeedStatusOutputRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        403:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+  /data-seed-request/{request_id}:
+    post:
+      displayName: DataSeedRequestStatusAPI
+      description: For a given requestId return it's status
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with request's status.
+          body:
+            application/json:
+              type: DataSeedRequestStatusOutputRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        403:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+    uriParameters:
+      request_id:
+        type: string
+        required: true
+  /data-seed-generate-presigned-upload-url:
+    post:
+      displayName: getPreSignedUrl
+      description: Add an existing Data Cloud Object as a new Semantic Data Object to a specific Semantic Model.
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns Pre Signed Url
+          body:
+            application/json:
+              type: PreSignedUrlResultRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlBadErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: PreSignedUrlInputRepresentation
+  /data-seed-generate-presigned-download-url/{file_type}/{request_id}:
+    post:
+      displayName: getDownloadPreSignedUrl
+      description: Generate Presigned URL To Download Files
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns Downloads Pre Signed Url
+          body:
+            application/json:
+              type: PreSignedDownloadUrlResultRepresentation
+        400:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlBadErrorRepresentation
+        500:
+          description: Returns the error if request is not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+    uriParameters:
+      request_id:
+        type: string
+        required: true
+      file_type:
+        type: string
+        required: true
+  /data-seed-fetch-salesforce-entities:
+    post:
+      displayName: OrgEntities
+      description: Return List of All Entities
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with list of entities.
+          body:
+            application/json:
+              type: EntitiesOutputRepresentation
+        400:
+          description: Returns the error if entities not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        403:
+          description: Returns the error if entities are not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        500:
+          description: Returns the error if server throws error
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: OrgEntitiesInputRepresentation
+  /data-seed-migrate:
+    post:
+      displayName: MigrateData
+      description: Migrate data from source org to target
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with request id.
+          body:
+            application/json:
+              type: MigrateDataOutputRepresentation
+        400:
+          description: Returns the error if data migration is not possible.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        403:
+          description: Returns the error if data migration not allowed.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        500:
+          description: Returns the error if server throws error
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: MigrateDataInputRepresentation
+  /data-seed-load/{dataseed_request_id}:
+    post:
+      displayName: LoadDataToTargetOrg
+      description: Load Data To Other Org
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with request id.
+          body:
+            application/json:
+              type: MigrateDataOutputRepresentation
+        400:
+          description: Returns the error if data load is not possible.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        403:
+          description: Returns the error if data load not allowed.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        500:
+          description: Returns the error if server throws error
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: LoadDataInputRepresentation
+    uriParameters:
+      dataseed_request_id:
+        type: string
+        required: true
+  /data-seed-auth-callback-status/{callback_id}:
+    post:
+      description: Retrieve the status and details of a previous authorization callback using the callback ID and organization ID.
+      displayName: Get Callback Status
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        Org-Url:
+          description: Org URL of the Org.
+          required: true
+          type: string
+        Access-Token:
+          description: Access token of the org.
+          required: true
+          type: string
+      responses:
+        200:
+          description: Successfully retrieved callback status.
+          body:
+            application/json:
+              type: AuthCallbackStatusRepresentation
+        404:
+          description: Callback not found.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+        500:
+          description: Internal Server Error – Failed to retrieve callback status.
+          body:
+            application/json:
+              type: DataSeedStatusErrorRepresentation
+    uriParameters:
+      callback_id:
+        description: The unique callback ID to retrieve status for.
+        required: true
+        type: string
+  /data-seed-fetch-salesforce-object-metadata:
+    post:
+      displayName: OrgEntitiesDetails
+      description: Return List of All Entities
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org url of the org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of url
+          required: true
+      responses:
+        200:
+          description: Returns the success response with list of entities.
+          body:
+            application/json:
+              type: EntitiesDetailsOutputRepresentation
+        400:
+          description: Returns the error if entities not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        403:
+          description: Returns the error if entities are not found.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        500:
+          description: Returns the error if server throws error
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: EntitiesDetailsInputRepresentation
+  /data-seed-org-details:
+    post:
+      displayName: FetchSalesforceOrgDetails
+      description: Retrieves details of a Salesforce organization using the provided organization ID, URL, and access token.
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        'Org-Url':
+          type: string
+          description: Org URL of the Org
+          required: true
+        'Access-Token':
+          type: string
+          description: Access token of the org
+          required: true
+      responses:
+        200:
+          description: Successfully fetched Salesforce organization details
+          body:
+            application/json:
+              type: OrgDetailsRepresentation
+        400:
+          description: Bad Request - Missing or invalid parameters
+          body:
+            application/json:
+              type: OrgDetailsErrorRepresentation
+        500:
+          description: Internal Server Error - Something went wrong on the server
+          body:
+            application/json:
+              type: OrgDetailsErrorRepresentation
+  /data-seed-generate:
+    post:
+      description: Generate Data API
+      displayName: generateDataAPI
+      headers:
+        'x-client-trace-id':
+          type: string
+          description: Id to track the request.
+          required: true
+        'x-salesforce-region':
+          type: string
+          description: The region of this request.
+          required: true
+        Org-Url:
+          description: Org URL of the Org.
+          required: true
+          type: string
+        Access-Token:
+          description: Access token of the org.
+          required: true
+          type: string
+      responses:
+        200:
+          description: Successfully retrieved callback status.
+          body:
+            application/json:
+              type: MigrateDataOutputRepresentation
+        400:
+          description: Bad request
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        404:
+          description: Config not found
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+        500:
+          description: Internal Server Error – Failed to retrieve callback status.
+          body:
+            application/json:
+              type: PreSignedUrlServerErrorRepresentation
+      body:
+        application/json:
+          type: MigrateDataInputRepresentation
+description: |
+  Data Seed service owned by AI Data Seeding Platform team that migrate or generates the data to a target org
+mediaType:
+  - application/json
+baseUri: api.salesforce.com