Skip to content

Commit de3b418

Browse files
committed
Generated client with openapi-generator 4.1.0 for Digital Enablement version 1.2.9.
1 parent 437ee7e commit de3b418

77 files changed

Lines changed: 6286 additions & 764 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

python/.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4.0.2
1+
4.1.0

python/MDES_Digital_Enablement.yaml

Lines changed: 2579 additions & 0 deletions
Large diffs are not rendered by default.

python/README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# openapi-client
2-
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously.
2+
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously. <br> __Authentication__ Mastercard uses OAuth 1.0a with body hash extension for authenticating the API clients. This requires every request that you send to Mastercard to be signed with an RSA private key. A private-public RSA key pair must be generated consisting of: <br> 1 . A private key for the OAuth signature for API requests. It is recommended to keep the private key in a password-protected or hardware keystore. <br> 2. A public key is shared with Mastercard during the project setup process through either a certificate signing request (CSR) or the API Key Generator. Mastercard will use the public key to verify the OAuth signature that is provided on every API call.<br> An OAUTH1.0a signer library is available on [GitHub](https://github.com/Mastercard/oauth1-signer-java) <br> __Encryption__<br> All communications between Issuer web service and the Mastercard gateway is encrypted using TLS. <br> __Additional Encryption of Sensitive Data__ In addition to the OAuth authentication, when using MDES Digital Enablement Service, any PCI sensitive and all account holder Personally Identifiable Information (PII) data must be encrypted. This requirement applies to the API fields containing encryptedData. Sensitive data is encrypted using a symmetric session (one-time-use) key. The symmetric session key is then wrapped with an RSA Public Key supplied by Mastercard during API setup phase (the Customer Encryption Key). <br> Java Client Encryption Library available on [GitHub](https://github.com/Mastercard/client-encryption-java)
33

44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

6-
- API version: 1.2.7
6+
- API version: 1.2.9
77
- Package version: 1.0.0
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99

@@ -52,7 +52,9 @@ from openapi_client.rest import ApiException
5252
from pprint import pprint
5353

5454

55-
# create an instance of the API class
55+
# Defining host is optional and default to https://api.mastercard.com/mdes
56+
configuration.host = "https://api.mastercard.com/mdes"
57+
# Create an instance of the API class
5658
api_instance = openapi_client.DeleteApi(openapi_client.ApiClient(configuration))
5759
delete_request_schema = openapi_client.DeleteRequestSchema() # DeleteRequestSchema | Contains the details of the request message. (optional)
5860

@@ -72,11 +74,12 @@ All URIs are relative to *https://api.mastercard.com/mdes*
7274
Class | Method | HTTP request | Description
7375
------------ | ------------- | ------------- | -------------
7476
*DeleteApi* | [**delete_digitization**](docs/DeleteApi.md#delete_digitization) | **POST** /digitization/static/1/0/delete | Used to delete one or more Tokens. The API is limited to 10 Tokens per request.
75-
*GetAssetApi* | [**get_asset**](docs/GetAssetApi.md#get_asset) | **GET** /assets/static/1/0/asset/{AssetId} | Used to retrieve static Assets from MDES�s repository, such as Card art, MasterCard brand logos, Issuer logos, and Terms and Conditions.
77+
*GetAssetApi* | [**get_asset**](docs/GetAssetApi.md#get_asset) | **GET** /assets/static/1/0/asset/{AssetId} | Used to retrieve static Assets from the MDES repository.
78+
*GetDigitalAssetsApi* | [**get_digital_assets**](docs/GetDigitalAssetsApi.md#get_digital_assets) | **POST** /digitization/static/1/0/getDigitalAssets | Used to retrieve digital assets derived from a funding PAN.
7679
*GetTaskStatusApi* | [**get_task_status**](docs/GetTaskStatusApi.md#get_task_status) | **POST** /digitization/static/1/0/getTaskStatus | Used to check the status of any asynchronous task that was previously requested.
7780
*GetTokenApi* | [**get_token**](docs/GetTokenApi.md#get_token) | **POST** /digitization/static/1/0/getToken | Used to get the status and details of a single given Token.
7881
*SearchTokensApi* | [**search_tokens**](docs/SearchTokensApi.md#search_tokens) | **POST** /digitization/static/1/0/searchTokens | Used to get basic token information for all tokens on a specified device, or all tokens mapped to the given Account PAN.
79-
*SuspendApi* | [**create_suspend**](docs/SuspendApi.md#create_suspend) | **POST** /digitization/static/1/0/suspend | Used to temporarily suspend one or more Tokens (for example, suspending all Tokens on a device in response to the device being lost). The API is limited to 10 Tokens per request.
82+
*SuspendApi* | [**create_suspend**](docs/SuspendApi.md#create_suspend) | **POST** /digitization/static/1/0/suspend | Used to temporarily suspend one or more Tokens.
8083
*TokenizeApi* | [**create_tokenize**](docs/TokenizeApi.md#create_tokenize) | **POST** /digitization/static/1/0/tokenize | Used to digitize a card to create a server-based Token.
8184
*TransactApi* | [**create_transact**](docs/TransactApi.md#create_transact) | **POST** /remotetransaction/static/1/0/transact | Used by the Token Requestor to create a Digital Secure Remote Payment (\&quot;DSRP\&quot;) transaction cryptogram using the credentials stored within MDES in order to perform a DSRP transaction.
8285
*UnsuspendApi* | [**create_unsuspend**](docs/UnsuspendApi.md#create_unsuspend) | **POST** /digitization/static/1/0/unsuspend | Used to unsuspend one or more previously suspended Tokens. The API is limited to 10 Tokens per request.
@@ -85,18 +88,27 @@ Class | Method | HTTP request | Description
8588

8689
## Documentation For Models
8790

91+
- [AccountHolderData](docs/AccountHolderData.md)
92+
- [AccountHolderDataOutbound](docs/AccountHolderDataOutbound.md)
8893
- [AssetResponseSchema](docs/AssetResponseSchema.md)
8994
- [AuthenticationMethods](docs/AuthenticationMethods.md)
9095
- [BillingAddress](docs/BillingAddress.md)
91-
- [CardInfo](docs/CardInfo.md)
92-
- [CardInfoData](docs/CardInfoData.md)
96+
- [CardAccountDataInbound](docs/CardAccountDataInbound.md)
97+
- [CardAccountDataOutbound](docs/CardAccountDataOutbound.md)
9398
- [DecisioningData](docs/DecisioningData.md)
9499
- [DeleteRequestSchema](docs/DeleteRequestSchema.md)
95100
- [DeleteResponseSchema](docs/DeleteResponseSchema.md)
96101
- [EncryptedPayload](docs/EncryptedPayload.md)
97102
- [EncryptedPayloadTransact](docs/EncryptedPayloadTransact.md)
98103
- [Error](docs/Error.md)
99104
- [ErrorsResponse](docs/ErrorsResponse.md)
105+
- [FundingAccountData](docs/FundingAccountData.md)
106+
- [FundingAccountInfo](docs/FundingAccountInfo.md)
107+
- [FundingAccountInfoEncryptedPayload](docs/FundingAccountInfoEncryptedPayload.md)
108+
- [GetDigitalAssetsEncryptedData](docs/GetDigitalAssetsEncryptedData.md)
109+
- [GetDigitalAssetsRequestSchema](docs/GetDigitalAssetsRequestSchema.md)
110+
- [GetDigitalAssetsRequestSchemaEncryptedPayload](docs/GetDigitalAssetsRequestSchemaEncryptedPayload.md)
111+
- [GetDigitalAssetsResponseSchema](docs/GetDigitalAssetsResponseSchema.md)
100112
- [GetTaskStatusRequestSchema](docs/GetTaskStatusRequestSchema.md)
101113
- [GetTaskStatusResponseSchema](docs/GetTaskStatusResponseSchema.md)
102114
- [GetTokenRequestSchema](docs/GetTokenRequestSchema.md)
@@ -105,6 +117,7 @@ Class | Method | HTTP request | Description
105117
- [NotifyTokenEncryptedPayload](docs/NotifyTokenEncryptedPayload.md)
106118
- [NotifyTokenUpdatedRequestSchema](docs/NotifyTokenUpdatedRequestSchema.md)
107119
- [NotifyTokenUpdatedResponseSchema](docs/NotifyTokenUpdatedResponseSchema.md)
120+
- [PhoneNumber](docs/PhoneNumber.md)
108121
- [ProductConfig](docs/ProductConfig.md)
109122
- [SearchTokensRequestSchema](docs/SearchTokensRequestSchema.md)
110123
- [SearchTokensResponseSchema](docs/SearchTokensResponseSchema.md)
@@ -113,8 +126,9 @@ Class | Method | HTTP request | Description
113126
- [Token](docs/Token.md)
114127
- [TokenDetail](docs/TokenDetail.md)
115128
- [TokenDetailData](docs/TokenDetailData.md)
116-
- [TokenDetailDataPAR](docs/TokenDetailDataPAR.md)
117-
- [TokenDetailTokenizeResponse](docs/TokenDetailTokenizeResponse.md)
129+
- [TokenDetailDataPAROnly](docs/TokenDetailDataPAROnly.md)
130+
- [TokenDetailDataTCCOnly](docs/TokenDetailDataTCCOnly.md)
131+
- [TokenDetailPAROnly](docs/TokenDetailPAROnly.md)
118132
- [TokenForLCM](docs/TokenForLCM.md)
119133
- [TokenInfo](docs/TokenInfo.md)
120134
- [TokenizeRequestSchema](docs/TokenizeRequestSchema.md)

python/generate-api-client.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
openapi-generator generate -i MDES_Digital_Enablement.yaml -g python -o .

python/openapi_client/__init__.py

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
"""
66
MDES for Merchants
77
8-
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously. # noqa: E501
8+
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously. <br> __Authentication__ Mastercard uses OAuth 1.0a with body hash extension for authenticating the API clients. This requires every request that you send to Mastercard to be signed with an RSA private key. A private-public RSA key pair must be generated consisting of: <br> 1 . A private key for the OAuth signature for API requests. It is recommended to keep the private key in a password-protected or hardware keystore. <br> 2. A public key is shared with Mastercard during the project setup process through either a certificate signing request (CSR) or the API Key Generator. Mastercard will use the public key to verify the OAuth signature that is provided on every API call.<br> An OAUTH1.0a signer library is available on [GitHub](https://github.com/Mastercard/oauth1-signer-java) <br> __Encryption__<br> All communications between Issuer web service and the Mastercard gateway is encrypted using TLS. <br> __Additional Encryption of Sensitive Data__ In addition to the OAuth authentication, when using MDES Digital Enablement Service, any PCI sensitive and all account holder Personally Identifiable Information (PII) data must be encrypted. This requirement applies to the API fields containing encryptedData. Sensitive data is encrypted using a symmetric session (one-time-use) key. The symmetric session key is then wrapped with an RSA Public Key supplied by Mastercard during API setup phase (the Customer Encryption Key). <br> Java Client Encryption Library available on [GitHub](https://github.com/Mastercard/client-encryption-java) # noqa: E501
99
10-
The version of the OpenAPI document: 1.2.7
10+
The version of the OpenAPI document: 1.2.9
1111
Generated by: https://openapi-generator.tech
1212
"""
1313

@@ -19,6 +19,7 @@
1919
# import apis into sdk package
2020
from openapi_client.api.delete_api import DeleteApi
2121
from openapi_client.api.get_asset_api import GetAssetApi
22+
from openapi_client.api.get_digital_assets_api import GetDigitalAssetsApi
2223
from openapi_client.api.get_task_status_api import GetTaskStatusApi
2324
from openapi_client.api.get_token_api import GetTokenApi
2425
from openapi_client.api.search_tokens_api import SearchTokensApi
@@ -37,18 +38,27 @@
3738
from openapi_client.exceptions import ApiKeyError
3839
from openapi_client.exceptions import ApiException
3940
# import models into sdk package
41+
from openapi_client.models.account_holder_data import AccountHolderData
42+
from openapi_client.models.account_holder_data_outbound import AccountHolderDataOutbound
4043
from openapi_client.models.asset_response_schema import AssetResponseSchema
4144
from openapi_client.models.authentication_methods import AuthenticationMethods
4245
from openapi_client.models.billing_address import BillingAddress
43-
from openapi_client.models.card_info import CardInfo
44-
from openapi_client.models.card_info_data import CardInfoData
46+
from openapi_client.models.card_account_data_inbound import CardAccountDataInbound
47+
from openapi_client.models.card_account_data_outbound import CardAccountDataOutbound
4548
from openapi_client.models.decisioning_data import DecisioningData
4649
from openapi_client.models.delete_request_schema import DeleteRequestSchema
4750
from openapi_client.models.delete_response_schema import DeleteResponseSchema
4851
from openapi_client.models.encrypted_payload import EncryptedPayload
4952
from openapi_client.models.encrypted_payload_transact import EncryptedPayloadTransact
5053
from openapi_client.models.error import Error
5154
from openapi_client.models.errors_response import ErrorsResponse
55+
from openapi_client.models.funding_account_data import FundingAccountData
56+
from openapi_client.models.funding_account_info import FundingAccountInfo
57+
from openapi_client.models.funding_account_info_encrypted_payload import FundingAccountInfoEncryptedPayload
58+
from openapi_client.models.get_digital_assets_encrypted_data import GetDigitalAssetsEncryptedData
59+
from openapi_client.models.get_digital_assets_request_schema import GetDigitalAssetsRequestSchema
60+
from openapi_client.models.get_digital_assets_request_schema_encrypted_payload import GetDigitalAssetsRequestSchemaEncryptedPayload
61+
from openapi_client.models.get_digital_assets_response_schema import GetDigitalAssetsResponseSchema
5262
from openapi_client.models.get_task_status_request_schema import GetTaskStatusRequestSchema
5363
from openapi_client.models.get_task_status_response_schema import GetTaskStatusResponseSchema
5464
from openapi_client.models.get_token_request_schema import GetTokenRequestSchema
@@ -57,6 +67,7 @@
5767
from openapi_client.models.notify_token_encrypted_payload import NotifyTokenEncryptedPayload
5868
from openapi_client.models.notify_token_updated_request_schema import NotifyTokenUpdatedRequestSchema
5969
from openapi_client.models.notify_token_updated_response_schema import NotifyTokenUpdatedResponseSchema
70+
from openapi_client.models.phone_number import PhoneNumber
6071
from openapi_client.models.product_config import ProductConfig
6172
from openapi_client.models.search_tokens_request_schema import SearchTokensRequestSchema
6273
from openapi_client.models.search_tokens_response_schema import SearchTokensResponseSchema
@@ -65,8 +76,9 @@
6576
from openapi_client.models.token import Token
6677
from openapi_client.models.token_detail import TokenDetail
6778
from openapi_client.models.token_detail_data import TokenDetailData
68-
from openapi_client.models.token_detail_data_par import TokenDetailDataPAR
69-
from openapi_client.models.token_detail_tokenize_response import TokenDetailTokenizeResponse
79+
from openapi_client.models.token_detail_data_par_only import TokenDetailDataPAROnly
80+
from openapi_client.models.token_detail_data_tcc_only import TokenDetailDataTCCOnly
81+
from openapi_client.models.token_detail_par_only import TokenDetailPAROnly
7082
from openapi_client.models.token_for_lcm import TokenForLCM
7183
from openapi_client.models.token_info import TokenInfo
7284
from openapi_client.models.tokenize_request_schema import TokenizeRequestSchema

python/openapi_client/api/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# import apis into api package
66
from openapi_client.api.delete_api import DeleteApi
77
from openapi_client.api.get_asset_api import GetAssetApi
8+
from openapi_client.api.get_digital_assets_api import GetDigitalAssetsApi
89
from openapi_client.api.get_task_status_api import GetTaskStatusApi
910
from openapi_client.api.get_token_api import GetTokenApi
1011
from openapi_client.api.search_tokens_api import SearchTokensApi

python/openapi_client/api/delete_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"""
44
MDES for Merchants
55
6-
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously. # noqa: E501
6+
The MDES APIs are designed as RPC style stateless web services where each API endpoint represents an operation to be performed. All request and response payloads are sent in the JSON (JavaScript Object Notation) data-interchange format. Each endpoint in the API specifies the HTTP Method used to access it. All strings in request and response objects are to be UTF-8 encoded. Each API URI includes the major and minor version of API that it conforms to. This will allow multiple concurrent versions of the API to be deployed simultaneously. <br> __Authentication__ Mastercard uses OAuth 1.0a with body hash extension for authenticating the API clients. This requires every request that you send to Mastercard to be signed with an RSA private key. A private-public RSA key pair must be generated consisting of: <br> 1 . A private key for the OAuth signature for API requests. It is recommended to keep the private key in a password-protected or hardware keystore. <br> 2. A public key is shared with Mastercard during the project setup process through either a certificate signing request (CSR) or the API Key Generator. Mastercard will use the public key to verify the OAuth signature that is provided on every API call.<br> An OAUTH1.0a signer library is available on [GitHub](https://github.com/Mastercard/oauth1-signer-java) <br> __Encryption__<br> All communications between Issuer web service and the Mastercard gateway is encrypted using TLS. <br> __Additional Encryption of Sensitive Data__ In addition to the OAuth authentication, when using MDES Digital Enablement Service, any PCI sensitive and all account holder Personally Identifiable Information (PII) data must be encrypted. This requirement applies to the API fields containing encryptedData. Sensitive data is encrypted using a symmetric session (one-time-use) key. The symmetric session key is then wrapped with an RSA Public Key supplied by Mastercard during API setup phase (the Customer Encryption Key). <br> Java Client Encryption Library available on [GitHub](https://github.com/Mastercard/client-encryption-java) # noqa: E501
77
8-
The version of the OpenAPI document: 1.2.7
8+
The version of the OpenAPI document: 1.2.9
99
Generated by: https://openapi-generator.tech
1010
"""
1111

0 commit comments

Comments
 (0)