@salesforce/lds-adapters-revenue-usage-detail 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,520 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '65.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  BindingObjectDetailOutputRepresentation:
+    description: Usage Detail API output representation for Binding Object Detail
+    type: object
+    properties:
+      bindingObjectRate:
+        description: Binding Object Rate Detail.
+        type: BindingObjectRateOutputRepresentation
+        required: false
+      bindingObjectResourceGrantAndPolicyDetail:
+        description: Binding Object Resource Grant and Policy Detail.
+        type: BindingObjectResourceGrantAndPolicyDetailOutputRepresentation
+        required: false
+      usageResource:
+        description: Usage Resource Detail
+        type: LookupDetailOutputRepresentation
+        required: false
+  BindingObjectGrantDetailOutputRepresentation:
+    description: Usage Detail API output representation for Binding Object Usage Resource
+      Grant Detail
+    type: object
+    properties:
+      effectiveEndDate:
+        description: Effective End Date
+        type: string | nil
+      effectiveStartDate:
+        description: Effective Start Date
+        type: string | nil
+      grantType:
+        description: Grant Type
+        type: string | nil
+      id:
+        description: Transaction Usage Entitlement Id
+        type: string | nil
+      product:
+        description: Product Lookup Detail
+        type: LookupDetailOutputRepresentation | nil
+      quantity:
+        description: Quantity
+        type: number | nil
+      record:
+        description: Record Lookup Detail
+        type: LookupDetailOutputRepresentation | nil
+      unitOfMeasure:
+        description: Unit of Measure
+        type: LookupDetailOutputRepresentation | nil
+      usageRefreshPolicy:
+        description: Usage grant refresh policy ID
+        type: PolicyDetailOutputRepresentation | nil
+      usageRolloverPolicy:
+        description: Usage grant rollover policy ID
+        type: PolicyDetailOutputRepresentation | nil
+      validityPeriodTerm:
+        description: Validity period term
+        type: number | nil
+      validityPeriodUnit:
+        description: Validity period unit
+        type: string | nil
+  BindingObjectRateAdjustmentsOutputRepresentation:
+    description: Usage Detail API output representation for Binding Target Rate Adjustments
+    type: object
+    properties:
+      lowerBound:
+        description: Minimum quantity for the adjustment to be applicable.
+        type: number | nil
+      name:
+        description: Name of the tier.
+        type: string | nil
+      rateAdjustmentId:
+        description: ID of the Rate Adjustment.
+        type: string | nil
+      rateAdjustmentType:
+        description: Type of rate adjustment.
+        type: string | nil
+      rateAdjustmentValue:
+        description: Value of the adjustment.
+        type: number | nil
+      tierUnitOfMeasure:
+        description: The unit of measure representing the tier.
+        type: string | nil
+      upperBound:
+        description: Maximum quantity for the adjustment to be applicable.
+        type: number | nil
+  BindingObjectRateOutputRepresentation:
+    description: Usage Detail API output representation for Binding Object Rate
+    type: object
+    properties:
+      id:
+        description: Binding Object Rate card entry ID
+        type: string | nil
+      negotiatedRate:
+        description: Negotiated Rate value
+        type: number | nil
+      negotiatedRateAdjustments:
+        description: List of rate adjustments
+        type: array
+        items:
+          type: BindingObjectRateAdjustmentsOutputRepresentation | nil
+      rate:
+        description: Rate value
+        type: number | nil
+      rateCardEntryId:
+        description: Rate card entry ID
+        type: string | nil
+      rateUnitOfMeasureName:
+        description: Rate unit of measure name
+        type: string | nil
+  BindingObjectResourceGrantAndPolicyDetailOutputRepresentation:
+    description: Usage Detail API output representation for Binding Object Resource
+      Grant And Policy Detail
+    type: object
+    properties:
+      bindingObjectGrantDetail:
+        description: Binding Object Resource Negotiated Grant Detail.
+        type: array
+        required: false
+        items:
+          type: BindingObjectGrantDetailOutputRepresentation
+      bindingObjectResourcePolicyDetail:
+        description: Binding Object Resource Policy Detail.
+        type: BindingObjectResourcePolicyDetailOutputRepresentation
+        required: false
+  BindingObjectResourcePolicyDetailOutputRepresentation:
+    description: Usage Detail API output representation for Usage Resource Policy
+      Detail
+    type: object
+    properties:
+      drawdownOrder:
+        description: Drawdown Order
+        type: string | nil
+      id:
+        description: Binding Object Usage Resource Policy Id
+        type: string | nil
+      ratingFrequencyPolicy:
+        description: Rating frequency policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageAggregationPolicy:
+        description: Usage aggregation policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageCommitmentPolicy:
+        description: Usage commitment policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageOveragePolicy:
+        description: Usage overage policy
+        type: PolicyDetailOutputRepresentation | nil
+  FieldsOutputRepresentation:
+    description: Usage Detail API output representation for optional fields in the QOCAL usage-based selling entities
+    type: object
+    properties:
+      displayValue:
+        description: The displayable value for a field.
+        type: string
+      value:
+        description: The value of a field in its raw data form.
+        type: any
+  LookupDetailOutputRepresentation:
+    description: Usage Detail API output representation for Record Detail
+    type: object
+    properties:
+      id:
+        description: Record ID
+        type: string | nil
+  NegotiatedGrantDetailOutputRepresentation:
+    description: Usage Detail API output representation for Negotiated Usage ResourceGrant
+      Detail
+    type: object
+    properties:
+      grantType:
+        description: Grant Type
+        type: string | nil
+      id:
+        description: Id
+        type: string | nil
+        required: false
+      quantity:
+        description: Quantity
+        type: number | nil
+      usageGrantNegotiable:
+        description: Usage grant negotiable
+        type: string | nil
+      usageRefreshPolicy:
+        description: Usage grant refresh policy ID
+        type: PolicyDetailOutputRepresentation | nil
+      usageRolloverPolicy:
+        description: Usage grant rollover policy ID
+        type: PolicyDetailOutputRepresentation | nil
+      validityPeriodTerm:
+        description: Validity period term
+        type: number | nil
+      validityPeriodUnit:
+        description: Validity period unit
+        type: string | nil
+  PolicyDetailOutputRepresentation:
+    description: Usage Detail API output representation for Policy Detail
+    type: object
+    properties:
+      id:
+        description: Policy ID
+        type: string | nil
+      negotiable:
+        description: Policy Negotiable Flag
+        type: string | nil
+  RateAdjustmentsOutputRepresentation:
+    description: Usage Detail API output representation for Rate Adjustments
+    type: object
+    properties:
+      fields:
+        description: List of optional fields and their values belonging to the QOCAL rate adjustment entity.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+      lowerBound:
+        description: Minimum quantity for the adjustment to be applicable.
+        type: number | nil # TODO: hand rolled. W-16276582
+      name:
+        description: Name of the tier.
+        type: string | nil # TODO: hand rolled. W-16276582
+      negotiatedRateAdjustmentId:
+        description: ID of the Negotiated Rate Adjustment.
+        type: string | nil # TODO: hand rolled. W-16276582
+      rateAdjustmentId:
+        description: ID of the Rate Adjustment.
+        type: string
+      rateAdjustmentType:
+        description: Type of rate adjustment.
+        type: string | nil # TODO: hand rolled. W-16276582
+      rateAdjustmentValue:
+        description: Value of the adjustment.
+        type: number | nil # TODO: hand rolled. W-16276582
+      tierUnitOfMeasure:
+        description: The unit of measure representing the tier.
+        type: string | nil # TODO: hand rolled. W-16276582
+      upperBound:
+        description: Maximum quantity for the adjustment to be applicable.
+        type: number | nil # TODO: hand rolled. W-16276582
+  RateCardEntryOutputRepresentation:
+    description: Usage Detail API output representation for Rate Card Entry
+    type: object
+    properties:
+      bindingInstanceTargetType:
+        description: Type of the target entity which is binding with this transaction
+        type: string | nil # TODO: hand rolled. W-16835275
+        required: false
+      bindingInstanceType:
+        description: A static enum with values “Self” and “Target”.
+        type: string | nil # TODO: hand rolled. W-16835275
+        required: false
+      chargeForOverages:
+        description: 'Specifies whether overage is allowed. Valid values are: Yes,
+          No, NA'
+        type: string | nil # TODO: hand rolled. W-16276582
+      fields:
+        description: List of optional fields and their values belonging to the QOCAL rate card entry entity.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+      isOptional:
+        description: Requirement flag for Commitment
+        type: boolean | nil
+        required: false
+      name:
+        description: Name of the resource.
+        type: string | nil # TODO: hand rolled. W-16276582
+      negotiable:
+        description: 'Specifies the negotiable type. Valid values are: Negotiable,
+          NonNegotiable'
+        type: string | nil # TODO: hand rolled. W-16276582
+      negotiatedRate:
+        description: User-overridden rate.
+        type: number | nil # TODO: hand rolled. W-16276582
+      negotiatedRateCardEntryId:
+        description: ID of the negotiated rate card entry.
+        type: string | nil # TODO: hand rolled. W-16276582
+      quantity:
+        description: Amount granted for the resource.
+        type: number | nil # TODO: hand rolled. W-16276582
+      rate:
+        description: Base rate.
+        type: number | nil # TODO: hand rolled. W-16276582
+      rateAdjustments:
+        description: List of tiers associated with the rate card entry, if applicable.
+        type: array
+        items:
+          type: RateAdjustmentsOutputRepresentation | nil
+      rateCardEntryId:
+        description: ID of the rate card entry.
+        type: string
+      rateUnitOfMeasureName:
+        description: Unit of measure name in which usage resource is rated.
+        type: string | nil
+      unitOfMeasure:
+        description: Unit of measure for the grant.
+        type: string | nil # TODO: hand rolled. W-16276582
+      unitOfMeasureCode:
+        description: The unit of measure code representing the overage rate.
+        type: string | nil # TODO: hand rolled. W-16276582
+      usageResourceGrantAndPolicyDetail:
+        description: Usage resource grant and policy detail.
+        type: UsageResourceGrantAndPolicyDetailOutputRepresentation
+        required: false
+      usageResourceId:
+        description: Usage Resource ID
+        type: string | nil
+        required: false
+  ResourcePolicyDetailOutputRepresentation:
+    description: Usage Detail API output representation for Usage Resource Policy
+      Detail
+    type: object
+    properties:
+      id:
+        description: Id
+        type: string | nil
+        required: false
+      ratingFrequencyPolicy:
+        description: Rating frequency policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageAggregationPolicy:
+        description: Usage aggregation policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageCommitmentPolicy:
+        description: Usage commitment policy
+        type: PolicyDetailOutputRepresentation | nil
+      usageOveragePolicy:
+        description: Usage overage policy
+        type: PolicyDetailOutputRepresentation | nil
+  UsageDetailBindingObjectOutputRepresentation:
+    description: Usage Detail API output representation for Binding Object
+    type: object
+    properties:
+      errors:
+        description: List of errors.
+        type: array
+        required: false
+        items:
+          type: UsageDetailErrorResponseRepresentation
+      records:
+        description: List of binding target detail records.
+        type: array
+        required: false
+        items:
+          type: BindingObjectDetailOutputRepresentation
+  UsageDetailErrorResponseRepresentation:
+    description: The output representation for an error for Usage Detail
+    type: object
+    properties:
+      errorCode:
+        description: Error Code
+        type: string
+      message:
+        description: Error Message
+        type: string
+      referenceId:
+        description: Reference ID
+        type: string
+  UsageDetailOutputRepresentation:
+    description: Usage Detail API output representation
+    type: object
+    properties:
+      errors:
+        description: List of errors.
+        type: array
+        required: false
+        items:
+          type: UsageDetailErrorResponseRepresentation
+      records:
+        description: List of rate card entry records.
+        type: array
+        required: false
+        items:
+          type: RateCardEntryOutputRepresentation
+  UsageResourceGrantAndPolicyDetailOutputRepresentation:
+    description: Usage Detail API output representation for Usage Resource Grant And
+      Policy Detail
+    type: object
+    properties:
+      grantDetail:
+        description: Usage resource grant detail.
+        type: NegotiatedGrantDetailOutputRepresentation
+        required: false
+      negotiatedGrantDetail:
+        description: Usage resource negotiated grant detail.
+        type: NegotiatedGrantDetailOutputRepresentation
+        required: false
+      negotiatedResourcePolicyDetail:
+        description: Usage resource negotiated policy detail.
+        type: ResourcePolicyDetailOutputRepresentation
+        required: false
+      resourcePolicyDetail:
+        description: Usage resource policy detail.
+        type: ResourcePolicyDetailOutputRepresentation
+        required: false
+/asset-management/assets/{assetId}/usage-details:
+  get:
+    displayName: getUsageDetail
+    description: Gets Usage Details.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: UsageDetailOutputRepresentation
+    queryParameters:
+      effectiveDate:
+        type: string
+        required: false
+        default: ''
+      optionalFields:
+        type: array
+        required: false
+        default: []
+        items:
+          type: string
+          (oas-collectionFormat): csv
+  uriParameters:
+    assetId:
+      type: string
+      required: true
+/commerce:
+  /quotes/line-items/{quoteLineItemId}/usage-details:
+    get:
+      displayName: getUsageDetail
+      description: Gets Usage Details.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: UsageDetailOutputRepresentation
+      queryParameters:
+        effectiveDate:
+          type: string
+          required: false
+          default: ''
+        optionalFields:
+          type: array
+          required: false
+          default: []
+          items:
+            type: string
+            (oas-collectionFormat): csv
+    uriParameters:
+      quoteLineItemId:
+        type: string
+        required: true
+  /sales-orders:
+    /line-items/{orderItemId}/usage-details:
+      get:
+        displayName: getUsageDetail
+        description: Gets Usage Details.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: UsageDetailOutputRepresentation
+        queryParameters:
+          effectiveDate:
+            type: string
+            required: false
+            default: ''
+          optionalFields:
+            type: array
+            required: false
+            default: []
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      uriParameters:
+        orderItemId:
+          type: string
+          required: true
+/revenue/usage-management/binding-objects/{bindingObjectId}/actions/usage-details:
+  get:
+    displayName: getBindingObjectUsageDetail
+    description: Gets Usage Details for Binding Object.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: UsageDetailBindingObjectOutputRepresentation
+    queryParameters:
+      effectiveDate:
+        type: string
+        required: false
+        default: ''
+  uriParameters:
+    bindingObjectId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,32 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'usage-detail'
+
+types:
+  UsageDetailOutputRepresentation:
+    (luvio.ttl): 1000
+  UsageDetailBindingObjectOutputRepresentation:
+    (luvio.ttl): 1000
+
+/asset-management/assets/{assetId}/usage-details:
+  get:
+    (luvio.adapter):
+      name: getAssetUsageDetails
+/commerce:
+  /quotes/line-items/{quoteLineItemId}/usage-details:
+    get:
+      (luvio.adapter):
+        name: getQuoteUsageDetails
+  /sales-orders:
+    /line-items/{orderItemId}/usage-details:
+      get:
+        (luvio.adapter):
+          name: getOrderUsageDetails
+/revenue/usage-management/binding-objects/{bindingObjectId}/actions/usage-details:
+  get:
+    (luvio.adapter):
+      name: getBindingObjectUsageDetails