|
| 1 | +# 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. |
| 3 | + |
| 4 | +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 5 | + |
| 6 | +- API version: 1.2.7 |
| 7 | +- Package version: 1.0.0 |
| 8 | +- Build package: org.openapitools.codegen.languages.PythonClientCodegen |
| 9 | + |
| 10 | +## Requirements. |
| 11 | + |
| 12 | +Python 2.7 and 3.4+ |
| 13 | + |
| 14 | +## Installation & Usage |
| 15 | +### pip install |
| 16 | + |
| 17 | +If the python package is hosted on Github, you can install directly from Github |
| 18 | + |
| 19 | +```sh |
| 20 | +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git |
| 21 | +``` |
| 22 | +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) |
| 23 | + |
| 24 | +Then import the package: |
| 25 | +```python |
| 26 | +import openapi_client |
| 27 | +``` |
| 28 | + |
| 29 | +### Setuptools |
| 30 | + |
| 31 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 32 | + |
| 33 | +```sh |
| 34 | +python setup.py install --user |
| 35 | +``` |
| 36 | +(or `sudo python setup.py install` to install the package for all users) |
| 37 | + |
| 38 | +Then import the package: |
| 39 | +```python |
| 40 | +import openapi_client |
| 41 | +``` |
| 42 | + |
| 43 | +## Getting Started |
| 44 | + |
| 45 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 46 | + |
| 47 | +```python |
| 48 | +from __future__ import print_function |
| 49 | +import time |
| 50 | +import openapi_client |
| 51 | +from openapi_client.rest import ApiException |
| 52 | +from pprint import pprint |
| 53 | + |
| 54 | + |
| 55 | +# create an instance of the API class |
| 56 | +api_instance = openapi_client.DeleteApi(openapi_client.ApiClient(configuration)) |
| 57 | +delete_request_schema = openapi_client.DeleteRequestSchema() # DeleteRequestSchema | Contains the details of the request message. (optional) |
| 58 | + |
| 59 | +try: |
| 60 | + # Used to delete one or more Tokens. The API is limited to 10 Tokens per request. |
| 61 | + api_response = api_instance.delete_digitization(delete_request_schema=delete_request_schema) |
| 62 | + pprint(api_response) |
| 63 | +except ApiException as e: |
| 64 | + print("Exception when calling DeleteApi->delete_digitization: %s\n" % e) |
| 65 | + |
| 66 | +``` |
| 67 | + |
| 68 | +## Documentation for API Endpoints |
| 69 | + |
| 70 | +All URIs are relative to *https://api.mastercard.com/mdes* |
| 71 | + |
| 72 | +Class | Method | HTTP request | Description |
| 73 | +------------ | ------------- | ------------- | ------------- |
| 74 | +*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. |
| 76 | +*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. |
| 77 | +*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. |
| 78 | +*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. |
| 80 | +*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. |
| 81 | +*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 (\"DSRP\") transaction cryptogram using the credentials stored within MDES in order to perform a DSRP transaction. |
| 82 | +*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. |
| 83 | +*NotifyTokenUpdatedApi* | [**notify_token_update__for_token_state_change**](docs/NotifyTokenUpdatedApi.md#notify_token_update__for_token_state_change) | **POST** /digitization/static/1/0/notifyTokenUpdated | Outbound API used by MDES to notify the Token Requestor of significant Token updates, such as when the Token is activated, suspended, unsuspended or deleted; or when information about the Token or its product configuration has changed. |
| 84 | + |
| 85 | + |
| 86 | +## Documentation For Models |
| 87 | + |
| 88 | + - [AssetResponseSchema](docs/AssetResponseSchema.md) |
| 89 | + - [AuthenticationMethods](docs/AuthenticationMethods.md) |
| 90 | + - [BillingAddress](docs/BillingAddress.md) |
| 91 | + - [CardInfo](docs/CardInfo.md) |
| 92 | + - [CardInfoData](docs/CardInfoData.md) |
| 93 | + - [DecisioningData](docs/DecisioningData.md) |
| 94 | + - [DeleteRequestSchema](docs/DeleteRequestSchema.md) |
| 95 | + - [DeleteResponseSchema](docs/DeleteResponseSchema.md) |
| 96 | + - [EncryptedPayload](docs/EncryptedPayload.md) |
| 97 | + - [EncryptedPayloadTransact](docs/EncryptedPayloadTransact.md) |
| 98 | + - [Error](docs/Error.md) |
| 99 | + - [ErrorsResponse](docs/ErrorsResponse.md) |
| 100 | + - [GetTaskStatusRequestSchema](docs/GetTaskStatusRequestSchema.md) |
| 101 | + - [GetTaskStatusResponseSchema](docs/GetTaskStatusResponseSchema.md) |
| 102 | + - [GetTokenRequestSchema](docs/GetTokenRequestSchema.md) |
| 103 | + - [GetTokenResponseSchema](docs/GetTokenResponseSchema.md) |
| 104 | + - [MediaContent](docs/MediaContent.md) |
| 105 | + - [NotifyTokenEncryptedPayload](docs/NotifyTokenEncryptedPayload.md) |
| 106 | + - [NotifyTokenUpdatedRequestSchema](docs/NotifyTokenUpdatedRequestSchema.md) |
| 107 | + - [NotifyTokenUpdatedResponseSchema](docs/NotifyTokenUpdatedResponseSchema.md) |
| 108 | + - [ProductConfig](docs/ProductConfig.md) |
| 109 | + - [SearchTokensRequestSchema](docs/SearchTokensRequestSchema.md) |
| 110 | + - [SearchTokensResponseSchema](docs/SearchTokensResponseSchema.md) |
| 111 | + - [SuspendRequestSchema](docs/SuspendRequestSchema.md) |
| 112 | + - [SuspendResponseSchema](docs/SuspendResponseSchema.md) |
| 113 | + - [Token](docs/Token.md) |
| 114 | + - [TokenDetail](docs/TokenDetail.md) |
| 115 | + - [TokenDetailData](docs/TokenDetailData.md) |
| 116 | + - [TokenDetailDataPAR](docs/TokenDetailDataPAR.md) |
| 117 | + - [TokenDetailTokenizeResponse](docs/TokenDetailTokenizeResponse.md) |
| 118 | + - [TokenForLCM](docs/TokenForLCM.md) |
| 119 | + - [TokenInfo](docs/TokenInfo.md) |
| 120 | + - [TokenizeRequestSchema](docs/TokenizeRequestSchema.md) |
| 121 | + - [TokenizeResponseSchema](docs/TokenizeResponseSchema.md) |
| 122 | + - [TransactEncryptedData](docs/TransactEncryptedData.md) |
| 123 | + - [TransactError](docs/TransactError.md) |
| 124 | + - [TransactRequestSchema](docs/TransactRequestSchema.md) |
| 125 | + - [TransactResponseSchema](docs/TransactResponseSchema.md) |
| 126 | + - [UnSuspendRequestSchema](docs/UnSuspendRequestSchema.md) |
| 127 | + - [UnSuspendResponseSchema](docs/UnSuspendResponseSchema.md) |
| 128 | + |
| 129 | + |
| 130 | +## Documentation For Authorization |
| 131 | + |
| 132 | + All endpoints do not require authorization. |
| 133 | + |
| 134 | +## Author |
| 135 | + |
| 136 | + |
| 137 | + |
| 138 | + |
0 commit comments