Upgrade Python SDK v12.40.0 (#38)

* commiting xsd and code changes * commiting code changes * commit byteArray changes * commiting code changes * commiting changelog * committing code changes * Committing code changes * commiting code changes for namespace issue * committing code changes --------- Co-authored-by: e5715887 <[email protected]> Co-authored-by: Nitin Lingayat <[email protected]>
Vantiv · Oct 17, 2024 · 14c9dc0 · 14c9dc0
1 parent 8d64ad2
commit 14c9dc0
Show file tree

Hide file tree

Showing 27 changed files with 13,944 additions and 12,270 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,28 @@
 = Vantiv eCommerce Python SDK
 
+==Version 12.40.0 (v12.40.0)(October 16, 2024)
+* Change: [cnpAPI v12.40] In authorization,sale and captureGivenAuth request new elements added-> 'typeOfDigitalCurrency' and 'conversionAffiliateId'.
+* Change: [cnpAPI v12.40] In existing simple type transactionAmountType range added between minInclusive value -999999999999  and maxInclusive value 999999999999
+* Change: [cnpAPI v12.40] In existing type authenticationProtocolVersionType new values '3','4','5','6','7','8' and '9' are added
+
+==Version 12.39.0 (October 16, 2024)
+* Change: [cnpAPI v12.39] In 'subMerchantCredit' 'payFacCredit','reserveCredit', 'payoutOrgCreditRequest' base changed from 'transactionTypeWithReportGroup' to 'transactionTypeWithReportGroupAndRtp'.
+* Change: [cnpAPI v12.39] To support new changed extension base for above txns ,New Complextype 'transactionTypeWithReportGroupAndRtp' added.
+* Change: [cnpAPI v12.39] New element 'fundingTransactionReferenceNumber' in authorization and sale response.
+
+==Version 12.38.0 (October 16, 2024)
+* Change: [cnpAPI v12.38] In existing Enum 'ActionTypeEnum' new value 'FIVD' added
+* Change: [cnpAPI v12.38] In existing complex element 'baseRequest' two more choices are added 'encryptionKeyRequest' and 'encryptedPayload'
+* Change: [cnpAPI v12.38] In existing complex element 'cnpOnlineResponse' one more choice is added 'encryptionKeyResponse'
+* Change: [cnpAPI v12.38] New element 'encryptionKeyRequest' is added of type 'encryptionKeyRequestEnum'
+* Change: [cnpAPI v12.38] To support 'encryptionKeyRequest' new Enum 'encryptionKeyRequestEnum' added with values 'CURRENT' and 'PREVIOUS'
+* Change: [cnpAPI v12.38] New complex element 'encryptionKeyResponse' is added with simple elements ->'encryptionKeySequence' of type 'encryptionKeySequenceType' and 'encryptionKey' of type 'encryptionKeyType'
+* Change: [cnpAPI v12.38] To support 'encryptionKeySequence' new simple type 'encryptionKeySequenceType' added with total Digits 19
+* Change: [cnpAPI v12.38] To support 'encryptionKey' new simple type 'encryptionKeyType' of type string with maxLength 15000
+* Change: [cnpAPI v12.38] New complex element 'encryptedPayload' is added with simple elements ->'encryptionKeySequence' of type 'encryptionKeySequenceType' and 'payload' of type 'payloadType'
+* Change: [cnpAPI v12.38] To support 'payload' new simple type 'payloadType' of type string with maxLength 15000
+* Change: [cnpAPI v12.38] In capture Request new complex element 'partialCapture' is added with elements-> 'partialCaptureSequenceNumber' of type 'integer' and 'partialCaptureTotalCount' of type 'partialCaptureCount'
+
 ==Version 12.37.1 (v12.37.1)(August 28, 2024)
 * Change: [cnpAPI v12.37.1] Added change to upgrade to a newer version of PyXB-X library which supports Python 3.12
 

diff --git a/SchemaCombined_v12.37.xsd → SchemaCombined_v12.40.xsd b/SchemaCombined_v12.37.xsd → SchemaCombined_v12.40.xsd
@@ -277,6 +277,11 @@
 
 
 
+
+
+
+
+
 
 <!--cnpRecurring-->
 
@@ -541,6 +546,15 @@
         </xs:complexContent>
     </xs:complexType>
 
+    <xs:complexType name="transactionTypeWithReportGroupAndRtp">
+        <xs:complexContent>
+            <xs:extension base="xp:transactionType">
+                <xs:attribute name="reportGroup" type="xs:string" use="required"/>
+                <xs:attribute name="rtp" type="xs:boolean" use="optional" />
+            </xs:extension>
+        </xs:complexContent>
+    </xs:complexType>
+
     <xs:complexType name="merchantDataType">
         <xs:all>
             <xs:element name="campaign" type="xs:string" minOccurs="0"/>
@@ -681,6 +695,9 @@
                             <xs:element name="authIndicator" type="xs:string" minOccurs="0"/>
                             <xs:element ref="xp:accountFundingTransactionData" minOccurs="0"/>
                             <xs:element name="fraudCheckAction" type="xs:string" minOccurs="0"/>
+                            <!--    US1938960-77433-->
+                            <xs:element name="typeOfDigitalCurrency" type="xs:string" minOccurs="0"/>
+                            <xs:element name="conversionAffiliateId" type="xs:string" minOccurs="0"/>
                         </xs:sequence>
                     </xs:choice>
                 </xs:extension>
@@ -741,6 +758,7 @@
                         <xs:element name="pin" type="xs:string" minOccurs="0"/>
                         <xs:element ref="xp:passengerTransportData" minOccurs="0"/>
                         <xs:element name="foreignRetailerIndicator" type="xs:string" minOccurs="0"/>
+                        <xs:element ref="xp:partialCapture" minOccurs="0"/>
                     </xs:all>
                 </xs:extension>
             </xs:complexContent>
@@ -839,6 +857,9 @@
                         <xs:element ref="xp:passengerTransportData" minOccurs="0"/>
                         <xs:element name="foreignRetailerIndicator" type="xs:string" minOccurs="0"/>
                         <xs:element ref="xp:accountFundingTransactionData" minOccurs="0"/>
+                        <!--    US1938960-77433-->
+                        <xs:element name="typeOfDigitalCurrency" type="xs:string" minOccurs="0"/>
+                        <xs:element name="conversionAffiliateId" type="xs:string" minOccurs="0"/>
                     </xs:sequence>
                 </xs:extension>
             </xs:complexContent>
@@ -921,6 +942,9 @@
                         <xs:element name="foreignRetailerIndicator" type="xs:string" minOccurs="0"/>
                         <xs:element ref="xp:accountFundingTransactionData" minOccurs="0"/>
                         <xs:element name="fraudCheckAction" type="xs:string" minOccurs="0"/>
+                        <!--    US1938960-77433-->
+                        <xs:element name="typeOfDigitalCurrency" type="xs:string" minOccurs="0"/>
+                        <xs:element name="conversionAffiliateId" type="xs:string" minOccurs="0"/>
                     </xs:sequence>
                 </xs:extension>
             </xs:complexContent>
@@ -1339,6 +1363,7 @@
                         <xs:element name="checkoutId" type="xs:string" minOccurs="0"/>
                         <!--If AuthMax is used -->
                         <xs:element ref="xp:authMax" minOccurs="0"/>
+                        <xs:element name="fundingTransactionReferenceNumber" type="xs:string" minOccurs="0"/>
                     </xs:all>
                 </xs:extension>
             </xs:complexContent>
@@ -1730,6 +1755,7 @@
                         <xs:element name="checkoutId" type="xs:string" minOccurs="0"/>
                         <!--If AuthMax is used -->
                         <xs:element ref="xp:authMax" minOccurs="0"/>
+                        <xs:element name="fundingTransactionReferenceNumber" type="xs:string" minOccurs="0"/>
                     </xs:all>
                 </xs:extension>
             </xs:complexContent>
@@ -2520,7 +2546,7 @@
     <xs:element name="payFacCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:element name="fundingSubmerchantId" type="xs:string"/>
@@ -2576,7 +2602,7 @@
     <xs:element name="reserveCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:choice>
@@ -2924,7 +2950,7 @@
     <xs:element name="payoutOrgCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:element name="fundingCustomerId" type="xs:string"/>
@@ -3289,6 +3315,15 @@
         </xs:all>
     </xs:complexType>
 
+    <xs:element name="partialCapture">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="partialCaptureSequenceNumber" type="xs:integer" minOccurs="0"/>
+                <xs:element name="partialCaptureTotalCount" type="xs:integer" minOccurs="0"/>
+       </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+
 <!--cnpBatch-->
 
 
@@ -3613,7 +3648,7 @@
     <xs:element name="submerchantCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:element name="fundingSubmerchantId" type="xs:string" />
@@ -3700,6 +3735,8 @@
             <xs:choice>
                 <xs:element ref="xp:transaction" />
                 <xs:element ref="xp:recurringTransaction" />
+                <xs:element ref="xp:encryptionKeyRequest"/>
+                <xs:element ref="xp:encryptedPayload" />
             </xs:choice>
         </xs:sequence>
         <xs:attribute name="version" type="xs:string" use="required" />
@@ -3723,6 +3760,7 @@
             <xs:choice>
                 <xs:element ref="xp:transactionResponse" minOccurs="0" />
                 <xs:element ref="xp:recurringTransactionResponse" minOccurs="0" />
+                <xs:element ref="xp:encryptionKeyResponse" minOccurs="0"/>
             </xs:choice>
             <xs:attribute name="response" type="xs:string" use="required" />
             <xs:attribute name="message" type="xs:string" use="required" />
@@ -4039,7 +4077,7 @@
     <xs:element name="submerchantCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:element name="fundingSubmerchantId" type="xs:string" />
@@ -4329,4 +4367,24 @@
         </xs:complexType>
     </xs:element>
 
+    <xs:element name="encryptionKeyRequest" type="xs:string" minOccurs="0"/>
+
+    <xs:element name="encryptionKeyResponse">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="encryptionKeySequence" type="xs:long" minOccurs="0" maxOccurs="1"/>
+                <xs:element name="encryptionKey" type="xs:string" minOccurs="0" maxOccurs="1"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+
+    <xs:element name="encryptedPayload">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="encryptionKeySequence" type="xs:long" minOccurs="0" maxOccurs="1"/>
+                <xs:element name="payload" type="xs:string" minOccurs="0" maxOccurs="1"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+
 </xs:schema>
diff --git a/docs/source/complextypes.rst b/docs/source/complextypes.rst
@@ -441,6 +441,13 @@ mposType
         :var track1Status: String or Number
         :var track2Status: String or Number
 
+partialCapture
+--------------
+    .. py:class:: vantivsdk.fields.partialCapture
+
+        :var partialCaptureSequenceNumber: String or Number
+        :var partialCaptureTotalCount: String or Number
+
 passengerTransportData
 ----------------------
     .. py:class:: vantivsdk.fields.passengerTransportData

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,4 +1,4 @@
-Vantiv eCommerce Python SDK 12.37.1!
+Vantiv eCommerce Python SDK 12.40.0!
 ====================================
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/transactions.rst b/docs/source/transactions.rst
@@ -129,6 +129,7 @@ authorization
         :var card: instance of :py:class:`vantivsdk.fields.cardType`
         :var cardholderAuthentication: instance of :py:class:`vantivsdk.fields.fraudCheckType`
         :var cnpTxnId: String or Number
+        :var conversionAffiliateId: String or Number
         :var crypto: String or Number
         :var customBilling: instance of :py:class:`vantivsdk.fields.customBilling`
         :var customerId: String or Number
@@ -174,6 +175,7 @@ authorization
         :var surchargeAmount: String or Number
         :var taxType: String or Number
         :var token: instance of :py:class:`vantivsdk.fields.cardTokenType`
+        :var typeOfDigitalCurrency: String or Number
         :var wallet: instance of :py:class:`vantivsdk.fields.wallet`
 
 balanceInquiry
@@ -207,6 +209,7 @@ capture
         :var lodgingInfo: instance of :py:class:`vantivsdk.fields.lodgingInfo`
         :var orderId: String or Number
         :var partial: String or Number
+        :var partialCapture: instance of :py:class:`vantivsdk.fields.partialCapture`
         :var passengerTransportData: instance of :py:class:`vantivsdk.fields.passengerTransportData`
         :var payPalNotes: String or Number
         :var payPalOrderComplete: String or Number
@@ -226,6 +229,7 @@ captureGivenAuth
         :var billToAddress: instance of :py:class:`vantivsdk.fields.billToAddress`
         :var businessIndicator: String or Number
         :var card: instance of :py:class:`vantivsdk.fields.cardType`
+        :var conversionAffiliateId: String or Number
         :var crypto: String or Number
         :var customBilling: instance of :py:class:`vantivsdk.fields.customBilling`
         :var customerId: String or Number
@@ -253,6 +257,7 @@ captureGivenAuth
         :var surchargeAmount: String or Number
         :var taxType: String or Number
         :var token: instance of :py:class:`vantivsdk.fields.cardTokenType`
+        :var typeOfDigitalCurrency: String or Number
 
 createPlan
 ----------
@@ -667,6 +672,7 @@ payFacCredit
         :var fundsTransferId: String or Number
         :var id: String or Number
         :var reportGroup: String or Number
+        :var rtp: String or Number
 
 payFacDebit
 -----------
@@ -689,6 +695,7 @@ payoutOrgCredit
         :var fundsTransferId: String or Number
         :var id: String or Number
         :var reportGroup: String or Number
+        :var rtp: String or Number
 
 payoutOrgDebit
 --------------
@@ -798,6 +805,7 @@ reserveCredit
         :var fundsTransferId: String or Number
         :var id: String or Number
         :var reportGroup: String or Number
+        :var rtp: String or Number
 
 reserveDebit
 ------------
@@ -827,6 +835,7 @@ sale
         :var cardholderAuthentication: instance of :py:class:`vantivsdk.fields.fraudCheckType`
         :var cnpInternalRecurringRequest: instance of :py:class:`vantivsdk.fields.cnpInternalRecurringRequestType`
         :var cnpTxnId: String or Number
+        :var conversionAffiliateId: String or Number
         :var crypto: String or Number
         :var customBilling: instance of :py:class:`vantivsdk.fields.customBilling`
         :var customerId: String or Number
@@ -880,6 +889,7 @@ sale
         :var surchargeAmount: String or Number
         :var taxType: String or Number
         :var token: instance of :py:class:`vantivsdk.fields.cardTokenType`
+        :var typeOfDigitalCurrency: String or Number
         :var wallet: instance of :py:class:`vantivsdk.fields.wallet`
 
 serviceStatusRequest
@@ -904,6 +914,7 @@ submerchantCredit
         :var fundsTransferId: String or Number
         :var id: String or Number
         :var reportGroup: String or Number
+        :var rtp: String or Number
         :var submerchantName: String or Number
 
 submerchantDebit

diff --git a/schema/cnpBatch_v12.37.xsd → schema/cnpBatch_v12.40.xsd b/schema/cnpBatch_v12.37.xsd → schema/cnpBatch_v12.40.xsd
@@ -2,7 +2,7 @@
 <xs:schema targetNamespace="http://www.vantivcnp.com/schema" xmlns:xs="http://www.w3.org/2001/XMLSchema"
            xmlns:xp="http://www.vantivcnp.com/schema" elementFormDefault="qualified" attributeFormDefault="unqualified">
 
-    <xs:include schemaLocation="cnpTransaction_v12.37.xsd" />
+    <xs:include schemaLocation="cnpTransaction_v12.40.xsd" />
 
     <xs:element name="cnpRequest">
         <xs:complexType>
@@ -333,7 +333,7 @@
     <xs:element name="submerchantCredit" substitutionGroup="xp:transaction">
         <xs:complexType>
             <xs:complexContent>
-                <xs:extension base="xp:transactionTypeWithReportGroup">
+                <xs:extension base="xp:transactionTypeWithReportGroupAndRtp">
                     <xs:choice>
                         <xs:sequence>
                             <xs:element name="fundingSubmerchantId" type="xp:merchantIdentificationType" />

diff --git a/schema/cnpCommon_v12.37.xsd → schema/cnpCommon_v12.40.xsd b/schema/cnpCommon_v12.37.xsd → schema/cnpCommon_v12.40.xsd
@@ -274,6 +274,7 @@
             <xs:enumeration value="X" />
             <xs:enumeration value="FIFA" />
             <xs:enumeration value="FIVC" />
+            <xs:enumeration value="FIVD" />
             <xs:enumeration value="FISC" />
             <xs:enumeration value="FISD" />
             <xs:enumeration value="FIPC" />
@@ -361,6 +362,8 @@
     <xs:simpleType name="transactionAmountType">
         <xs:restriction base="xs:integer">
             <xs:totalDigits value="12" />
+            <xs:minInclusive value="-999999999999"/>
+            <xs:maxInclusive value="999999999999"/>
         </xs:restriction>
     </xs:simpleType>
 
@@ -1390,4 +1393,36 @@
         </xs:restriction>
     </xs:simpleType>
 
+    <xs:simpleType name="encryptionKeyRequestEnum">
+        <xs:restriction base="xs:string">
+            <xs:enumeration value="CURRENT"/>
+            <xs:enumeration value="PREVIOUS"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="encryptionKeySequenceType">
+        <xs:restriction base="xs:long">
+            <xs:totalDigits value="19"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="encryptionKeyType">
+        <xs:restriction base="xs:string">
+            <xs:maxLength value="15000"/>
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="payloadType">
+        <xs:restriction base="xs:string">
+            <xs:maxLength value="15000" />
+        </xs:restriction>
+    </xs:simpleType>
+
+    <xs:simpleType name="partialCaptureCount">
+        <xs:restriction base="xs:integer">
+            <xs:minInclusive value="1" />
+            <xs:maxInclusive value="99" />
+        </xs:restriction>
+    </xs:simpleType>
+
 </xs:schema>