@salesforce/lds-adapters-industries-cpq 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,850 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  AdditionalFieldsOutputRepresentation:
+    description: Output representation for custom fields
+    type: object
+    properties:
+      fieldApiName:
+        description: Api name of the custom field
+        type: string
+        required: false
+      fieldName:
+        description: Name of the custom field
+        type: string
+        required: false
+      value:
+        description: Value of the custom field
+        type: string
+        required: false
+  ApiStatusOutputRepresentation:
+    description: API Status Output Representation
+    type: object
+    properties:
+      httpStatusCode:
+        description: HTTP Status Code for API
+        type: string
+        required: false
+      messages:
+        description: API status messages
+        type: array
+        required: false
+        items:
+          type: CpqMessageOutputRepresentation
+      statusCode:
+        description: Status Code
+        type: string
+      statusMessage:
+        description: Status Message - Display label for API status
+        type: string
+        required: false
+  AttributeCategoryOutputRepresentation:
+    description: Output Representation for AttributeCategory
+    type: object
+    properties:
+      code:
+        description: Code of the attribute category
+        type: string
+        required: false
+      description:
+        description: Description of the attribute category
+        type: string
+        required: false
+      name:
+        description: Name of the attribute category
+        type: string
+        required: false
+      records:
+        description: Attributes in this category
+        type: array
+        required: false
+        items:
+          type: ProductAttributeOutputRepresentation
+      status:
+        description: Status of the attribute category
+        type: string
+        required: false
+      totalSize:
+        description: Total Size of attributes in this category
+        type: integer
+        required: false
+      usageType:
+        description: Usage Type of the attribute category
+        type: string
+        required: false
+  AttributePickListOutputRepresentation:
+    description: Attribute picklist output representation
+    type: object
+    properties:
+      code:
+        description: Code of attribute picklist
+        type: string
+        required: false
+      description:
+        description: Description of attribute picklist
+        type: string
+        required: false
+      id:
+        description: Id of attribute picklist
+        type: string
+        required: false
+      name:
+        description: Name of attribute picklist
+        type: string
+        required: false
+      status:
+        description: Status of attribute picklist - Active/InActive
+        type: string
+        required: false
+      values:
+        description: List of values of attribute picklist
+        type: array
+        required: false
+        items:
+          type: AttributePickListValueOutputRepresentation
+  AttributePickListValueOutputRepresentation:
+    description: Attribute picklist value output representation
+    type: object
+    properties:
+      code:
+        description: Code of attribute picklist value
+        type: string
+        required: false
+      description:
+        description: Description of attribute picklist value
+        type: string
+        required: false
+      displayValue:
+        description: Display value of attribute picklist value
+        type: string
+        required: false
+      id:
+        description: Id of attribute picklist value
+        type: string
+        required: false
+      isBooleanValue:
+        description: Is the attribute picklist value a boolean
+        type: boolean
+        required: false
+      label:
+        description: Label of attribute picklist value
+        type: string
+        required: false
+      name:
+        description: Name of attribute picklist value
+        type: string
+        required: false
+      sequence:
+        description: Sequence of attribute picklist value
+        type: integer
+        required: false
+      status:
+        description: Status of attribute picklist value - Active/InActive
+        type: string
+        required: false
+      textValue:
+        description: Text value of the attribute picklist value
+        type: string
+        required: false
+  CpqBaseDetailsOutputRepresentation:
+    description: Base representation for details apis
+    type: object
+    properties:
+      apiStatus:
+        description: Api Status Object
+        type: ApiStatusOutputRepresentation
+      result:
+        description: Result object
+        type: object
+  CpqBaseListOutputRepresentation:
+    description: Base representation for list apis
+    type: object
+    properties:
+      apiStatus:
+        description: Api Status Object
+        type: ApiStatusOutputRepresentation
+      limit:
+        description: Limit
+        type: integer
+        required: false
+      offSet:
+        description: Offset
+        type: integer
+        required: false
+      query:
+        description: Input Query Object
+        type: any
+        required: false
+      result:
+        description: Result object
+        type: array
+        items:
+          type: object
+      total:
+        description: Totals
+        type: integer
+        required: false
+  CpqMessageOutputRepresentation:
+    description: Output representation for apis message
+    type: object
+    properties:
+      code:
+        description: Code specifying the type/cause of message
+        type: string
+        required: false
+      detail:
+        description: Message detail contains any info needed other than message text
+        type: string
+        required: false
+      message:
+        description: Message text
+        type: string
+        required: false
+      severity:
+        description: Message Severity
+        type: string
+        required: false
+  PreviewInputRepresentation:
+    description: Input Representation for Preview Product or cart item.
+    type: object
+    properties:
+      cartId:
+        description: Id of the Cart to which ths conigured items belongs to.
+        type: string
+        required: false
+      configuredItems:
+        description: Items to be configure and update to the cart.
+        type: array
+        required: false
+        items:
+          type: object
+      correlationId:
+        description: CorrelationId
+        type: string
+        required: false
+      customFields:
+        description: Key value pair of custom fields.
+        type: object
+        required: false
+        properties:
+          //:
+            type: string
+      userContext:
+        description: User context in which cart would be created.
+        type: object
+        required: false
+  PricingModelOutputRepresentation:
+    description: Pricing Model representation
+    type: object
+    properties:
+      frequency:
+        description: Frequency of Recurrence
+        type: string
+        required: false
+      id:
+        description: Price Model Id
+        type: string
+        required: false
+      name:
+        description: Name of Pricing Model
+        type: string
+        required: false
+      occurrence:
+        description: Number of occurrences
+        type: integer
+        required: false
+      pricingModelType:
+        description: Type of Pricing Model
+        type: string
+        required: false
+      unitOfMeasure:
+        description: Unit of Measure
+        type: string
+        required: false
+  ProductAttributeOutputRepresentation:
+    description: Product Attributes output representation
+    type: object
+    properties:
+      attributeCategoryId:
+        description: Attribute Category Id
+        type: string
+        required: false
+      attributePickList:
+        description: Attribute picklist in product attribute
+        type: AttributePickListOutputRepresentation
+        required: false
+      code:
+        description: Code of the attribute
+        type: string
+        required: false
+      dataType:
+        description: DataType of product attribute
+        type: string
+        required: false
+      defaultHelpText:
+        description: Help text of the attribute
+        type: string
+        required: false
+      defaultValue:
+        description: Default of the attribute
+        type: string
+        required: false
+      description:
+        description: description of product attribute
+        type: string
+        required: false
+      hidden:
+        description: Is true if attribute is hidden
+        type: boolean
+        required: false
+      id:
+        description: Id of product attribute
+        type: string
+        required: false
+      isPriceImpacting:
+        description: Is Price Impacting field in attribute
+        type: boolean
+        required: false
+      label:
+        description: Label of the attribute
+        type: string
+        required: false
+      name:
+        description: name of product attribute
+        type: string
+        required: false
+      status:
+        description: Status of product attribute - Active/InActive
+        type: string
+        required: false
+      userValue:
+        description: user value of the product attribute
+        type: string
+        required: false
+  ProductConfigurationInputRepresentation:
+    description: Input Representation for Product Configuration.
+    type: object
+    properties:
+      configuration:
+        description: Product delta configurations
+        type: object
+        required: false
+      productId:
+        description: Product Id
+        type: string
+        required: false
+  ProductDeltaConfigurationInputRepresentation:
+    description: Input Representation for Product Delta Configuration.
+    type: object
+    properties:
+      attributes:
+        description: Product attribute configuration
+        type: object
+        required: false
+        properties:
+          //:
+            type: object
+      quantity:
+        description: Product quantity
+        format: double
+        type: number
+        required: false
+  ProductDetailsInputRepresentation:
+    description: Input Representation for Product Details.
+    type: object
+    properties:
+      additionalFields:
+        description: Key value pair of additional fields
+        type: array
+        required: false
+        items:
+          type: string
+      catalogId:
+        description: Id of the catalog.
+        type: string
+      correlationId:
+        description: CorrelationId
+        type: string
+        required: false
+      userContext:
+        description: User context
+        type: object
+        required: false
+  ProductDetailsOutputRepresentation:
+    description: Product details output representation
+    type: object
+    properties:
+      attributes:
+        description: List of attributes in the product
+        type: array
+        required: false
+        items:
+          type: ProductAttributeOutputRepresentation
+      childProducts:
+        description: List of Child products
+        type: array
+        required: false
+        items:
+          type: ProductDetailsOutputRepresentation
+      displayName:
+        description: DisplayName of the product
+        type: string
+        required: false
+      prices:
+        description: List of prices of the product
+        type: array
+        required: false
+        items:
+          type: ProductPricesOutputRepresentation
+      quantity:
+        description: quantity of the product
+        type: string
+        required: false
+      additionalFields:
+        description: List of additional fields
+        type: array
+        required: false
+        items:
+          type: AdditionalFieldsOutputRepresentation
+      attributeCategories:
+        description: List of attribute categories in a product
+        type: array
+        required: false
+        items:
+          type: AttributeCategoryOutputRepresentation
+      description:
+        description: Description of the product
+        type: string
+        required: false
+      id:
+        description: Id of the product
+        type: string
+        required: false
+      isComponentRequired:
+        description: Is Component required of a product
+        type: boolean
+        required: false
+      isDefaultComponent:
+        description: Is the product a Default Component
+        type: boolean
+        required: false
+      isQuantityEditable:
+        description: Is Quantity of product editable
+        type: boolean
+        required: false
+      name:
+        description: Name of the product
+        type: string
+        required: false
+      productQuantity:
+        description: Quantity information of a product
+        type: ProductQuantityOutputRepresentation
+        required: false
+      status:
+        description: Status of the product
+        type: string
+        required: false
+  ProductListInputRepresentation:
+    description: Input Representation for Product List.
+    type: object
+    properties:
+      catalogId:
+        description: Id of the catalog.
+        type: string
+      categoryId:
+        description: Id of the catalog.
+        type: string
+        required: false
+      correlationId:
+        description: CorrelationId
+        type: string
+        required: false
+      limit:
+        description: Number of item count you want in the response
+        type: integer
+        required: false
+      offset:
+        description: Offset size from which you need the catalog count
+        type: integer
+        required: false
+      orderBy:
+        description: Sort by ascending/descending order
+        type: array
+        required: false
+        items:
+          type: string
+      userContext:
+        description: User context
+        type: object
+        required: false
+  ProductListOutputRepresentation:
+    description: Product list output representation
+    type: object
+    properties:
+      childProducts:
+        description: List of Child Products
+        type: array
+        required: false
+        items:
+          type: ProductListOutputRepresentation
+      prices:
+        description: List of prices of the product
+        type: array
+        required: false
+        items:
+          type: ProductPricesOutputRepresentation
+      additionalFields:
+        description: List of additional fields
+        type: array
+        required: false
+        items:
+          type: AdditionalFieldsOutputRepresentation
+      attributeCategories:
+        description: List of attribute categories in a product
+        type: array
+        required: false
+        items:
+          type: AttributeCategoryOutputRepresentation
+      description:
+        description: Description of the product
+        type: string
+        required: false
+      id:
+        description: Id of the product
+        type: string
+        required: false
+      isComponentRequired:
+        description: Is Component required of a product
+        type: boolean
+        required: false
+      isDefaultComponent:
+        description: Is the product a Default Component
+        type: boolean
+        required: false
+      isQuantityEditable:
+        description: Is Quantity of product editable
+        type: boolean
+        required: false
+      name:
+        description: Name of the product
+        type: string
+        required: false
+      productQuantity:
+        description: Quantity information of a product
+        type: ProductQuantityOutputRepresentation
+        required: false
+      status:
+        description: Status of the product
+        type: string
+        required: false
+  ProductOutputRepresentation:
+    description: Product output representation
+    type: object
+    properties:
+      additionalFields:
+        description: List of additional fields
+        type: array
+        required: false
+        items:
+          type: AdditionalFieldsOutputRepresentation
+      attributeCategories:
+        description: List of attribute categories in a product
+        type: array
+        required: false
+        items:
+          type: AttributeCategoryOutputRepresentation
+      description:
+        description: Description of the product
+        type: string
+        required: false
+      id:
+        description: Id of the product
+        type: string
+        required: false
+      isComponentRequired:
+        description: Is Component required of a product
+        type: boolean
+        required: false
+      isDefaultComponent:
+        description: Is the product a Default Component
+        type: boolean
+        required: false
+      isQuantityEditable:
+        description: Is Quantity of product editable
+        type: boolean
+        required: false
+      name:
+        description: Name of the product
+        type: string
+        required: false
+      productQuantity:
+        description: Quantity information of a product
+        type: ProductQuantityOutputRepresentation
+        required: false
+      status:
+        description: Status of the product
+        type: string
+        required: false
+  ProductPricesOutputRepresentation:
+    description: Product Prices output representation
+    type: object
+    properties:
+      currencyIsoCode:
+        description: Currency ISO Code of the given price
+        type: string
+        required: false
+      effectiveFrom:
+        description: Effective From Date of the given price
+        type: string
+        required: false
+      effectiveTo:
+        description: Effective To Date of the given price
+        type: string
+        required: false
+      price:
+        description: Price
+        format: double
+        type: number
+        required: false
+      priceBookEntryId:
+        description: Price book entry id of the given price
+        type: string
+        required: false
+      priceBookId:
+        description: Price book id of given price
+        type: string
+        required: false
+      pricingModel:
+        description: Pricing Model of the given price
+        type: PricingModelOutputRepresentation
+        required: false
+  ProductQuantityOutputRepresentation:
+    description: Product Quantity information output representation
+    type: object
+    properties:
+      maxQuantity:
+        description: Max Quantity allowed of a product
+        format: double
+        type: number
+        required: false
+      minQuantity:
+        description: Min Quantity allowed of a product
+        format: double
+        type: number
+        required: false
+      quantity:
+        description: Default Quantity allowed of a product
+        format: double
+        type: number
+        required: false
+  SearchOffersInputRepresentation:
+    description: Offers List input representation
+    type: object
+    properties:
+      catalogId:
+        description: Id of the catalog.
+        type: string
+        required: false
+      categoryId:
+        description: Id of of the category.
+        type: string
+        required: false
+      correlationId:
+        description: CorrelationId
+        type: string
+        required: false
+      customFields:
+        description: CustomFields
+        type: array
+        required: false
+        items:
+          type: string
+      limit:
+        description: Number of item count you want in the response
+        type: integer
+        required: false
+      offset:
+        description: Offset size from which you need the item count
+        type: integer
+        required: false
+      orderBy:
+        description: Sort by ascending/descending order
+        type: array
+        required: false
+        items:
+          type: string
+      query:
+        description: Search query
+        type: any
+        required: false
+      userContext:
+        description: User context in which cart would be created.
+        type: object
+        required: false
+  SearchOffersOutputRepresentation:
+    description: Search Offers output representation
+    type: object
+    properties:
+      prices:
+        description: List of prices of the product
+        type: array
+        required: false
+        items:
+          type: ProductPricesOutputRepresentation
+      additionalFields:
+        description: List of additional fields
+        type: array
+        required: false
+        items:
+          type: AdditionalFieldsOutputRepresentation
+      attributeCategories:
+        description: List of attribute categories in a product
+        type: array
+        required: false
+        items:
+          type: AttributeCategoryOutputRepresentation
+      description:
+        description: Description of the product
+        type: string
+        required: false
+      id:
+        description: Id of the product
+        type: string
+        required: false
+      isComponentRequired:
+        description: Is Component required of a product
+        type: boolean
+        required: false
+      isDefaultComponent:
+        description: Is the product a Default Component
+        type: boolean
+        required: false
+      isQuantityEditable:
+        description: Is Quantity of product editable
+        type: boolean
+        required: false
+      name:
+        description: Name of the product
+        type: string
+        required: false
+      productQuantity:
+        description: Quantity information of a product
+        type: ProductQuantityOutputRepresentation
+        required: false
+      status:
+        description: Status of the product
+        type: string
+        required: false
+  PreviewInputRepresentationWrapper:
+    description: Preview Input Representation Wrapper
+    type: object
+    properties:
+      previewInput:
+        description: Key for api call
+        type: PreviewInputRepresentation
+  SearchOffersInputRepresentationWrapper:
+    description: Search Offers Input Representation Wrapper
+    type: object
+    properties:
+      SearchOffersInput:
+        description: Key for api call
+        type: SearchOffersInputRepresentation
+  ProductDetailsInputRepresentationWrapper:
+    description: Product Details Input Representation Wrapper
+    type: object
+    properties:
+      requestBody:
+        description: Key for api call
+        type: ProductDetailsInputRepresentation
+  ProductListInputRepresentationWrapper:
+    description: Product List Input Representation Wrapper
+    type: object
+    properties:
+      requestBody:
+        description: Key for api call
+        type: ProductListInputRepresentation
+/connect/cpq:
+  /preview:
+    post:
+      description: Preview product
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CpqBaseListOutputRepresentation
+      body:
+        application/json:
+          type: PreviewInputRepresentationWrapper
+          #required: false
+          (oas-body-name): previewInput
+  /products:
+    post:
+      displayName: postProductList
+      description: Products List
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CpqBaseListOutputRepresentation
+      body:
+        application/json:
+          type: ProductListInputRepresentationWrapper
+          (oas-body-name): requestBody
+    /search:
+      post:
+        displayName: postSearchOffers
+        description: Get products list based on search query
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CpqBaseListOutputRepresentation
+        body:
+          application/json:
+            type: SearchOffersInputRepresentationWrapper
+            (oas-body-name): SearchOffersInput
+    /{productId}:
+      post:
+        displayName: postProductDetails
+        description: Product Details
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CpqBaseDetailsOutputRepresentation
+        body:
+          application/json:
+            type: ProductDetailsInputRepresentationWrapper
+            (oas-body-name): requestBody
+      uriParameters:
+        productId:
+          type: string
+          required: true