Merge pull request #17 from chargebee/release/0.0.6

Release/0.0.6

gradle.properties

@@ -2,7 +2,7 @@
 sonar_project_key=chargebee_cb-provider-spi
 build_project_name=cb-provider-spi
 build_group=org.chargebee.spi
-build_version=0.0.4
+build_version=0.0.6
 # Artifactory config to be controlled at build time by CI/CD
 artifactory_build_url=https://artifactory.url/maven/build
 artifactory_publish_url=https://artifactory.url/maven/publish

spec/spi/openapi_tax.yml

@@ -293,6 +293,7 @@ paths:
       operationId: fetchCreditNote
       parameters:
         - $ref: '#/components/parameters/CreditNoteIdPathParam'
+        - $ref: '#/components/parameters/InvoiceIdQueryParam'
       responses:
         '200':
           description: "Credit note retrieved successfully."
@@ -321,6 +322,7 @@ paths:
       operationId: commitCreditNote
       parameters:
         - $ref: '#/components/parameters/CreditNoteIdPathParam'
+        - $ref: '#/components/parameters/InvoiceIdQueryParam'
       responses:
         '204':
           description: Credit note committed successfully.
@@ -345,6 +347,7 @@ paths:
       operationId: voidCreditNote
       parameters:
         - $ref: '#/components/parameters/CreditNoteIdPathParam'
+        - $ref: '#/components/parameters/InvoiceIdQueryParam'
       responses:
         '204':
           description: "Credit note voided successfully."
@@ -987,6 +990,9 @@ components:
           type: string
           description: "The unique identifier of the invoice in Chargebee to which this credit note belongs."
           maxLength: 50
+        invoiceId:
+          type: string
+          description: "The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider."
         creditNoteType:
           $ref: '#/components/schemas/CreditNoteType'
         documentDateTime:
@@ -1302,6 +1308,13 @@ components:
       schema:
         type: string
       description: "The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider."
+    InvoiceIdQueryParam:
+      in: query
+      name: invoiceId
+      required: false
+      schema:
+        type: string
+      description: "The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider."
     CreditNoteIdPathParam:
       in: path
       name: creditNoteId

spec/spi/openapi_trn.yml

@@ -25,7 +25,7 @@ info:
     - Translates API requests (as defined in this document) from Chargebee to the request format specified by the Service Provider's API.
     - Translates API responses from the Service Provider APIs to the format understood by Chargebee (as defined in this document).
     ### Authorization
-    Chargebee uses HTTP header-based authorization for all the API endpoints associated with Service Adapter. We dynamically pass this authorization key in the HTTP header. The parameter that holds this key is found in the JSON object `api_configuration` quired for configuring your onboarding on Chargebee's marketplace. In the `api_configuration` object, our [Taxes Service Adapter SPI](https://chargebee.atlassian.net/l/cp/ca5aZ1mA) checks the authorization key parameter from `credential_configuration.id` and creates the HTTP header-based input query parameter for authorization. The `credential_configuration` is an array of objects with an `id` attribute, and the value of `id` is the parameter containing the authorization key.
+    Chargebee uses HTTP header-based authorization for all the API endpoints associated with Service Adapter. We dynamically pass this authorization key in the HTTP header. The parameter that holds this key is found in the JSON object `api_configuration` required for configuring your onboarding on Chargebee's marketplace. In the `api_configuration` object, our [Taxes Service Adapter SPI](https://chargebee.atlassian.net/l/cp/ca5aZ1mA) checks the authorization key parameter from `credential_configuration.id` and creates the HTTP header-based input query parameter for authorization. The `credential_configuration` is an array of objects with an `id` attribute, and the value of `id` is the parameter containing the authorization key.
       
       Following are the JSON snippets for your reference.
       
@@ -539,4 +539,4 @@ components:
       in: header
 security:
   - bearerAuth: []
-  - apiKey: [] 
+  - apiKey: []