|
| 1 | +# openapi_client |
| 2 | + |
| 3 | +OpenapiClient - the Ruby gem for the MDES for Merchants |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | + |
| 8 | +This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 9 | + |
| 10 | +- API version: 1.2.7 |
| 11 | +- Package version: 1.0.0 |
| 12 | +- Build package: org.openapitools.codegen.languages.RubyClientCodegen |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +### Build a gem |
| 17 | + |
| 18 | +To build the Ruby code into a gem: |
| 19 | + |
| 20 | +```shell |
| 21 | +gem build openapi_client.gemspec |
| 22 | +``` |
| 23 | + |
| 24 | +Then either install the gem locally: |
| 25 | + |
| 26 | +```shell |
| 27 | +gem install ./openapi_client-1.0.0.gem |
| 28 | +``` |
| 29 | + |
| 30 | +(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies) |
| 31 | + |
| 32 | +or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). |
| 33 | + |
| 34 | +Finally add this to the Gemfile: |
| 35 | + |
| 36 | + gem 'openapi_client', '~> 1.0.0' |
| 37 | + |
| 38 | +### Install from Git |
| 39 | + |
| 40 | +If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile: |
| 41 | + |
| 42 | + gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git' |
| 43 | + |
| 44 | +### Include the Ruby code directly |
| 45 | + |
| 46 | +Include the Ruby code directly using `-I` as follows: |
| 47 | + |
| 48 | +```shell |
| 49 | +ruby -Ilib script.rb |
| 50 | +``` |
| 51 | + |
| 52 | +## Getting Started |
| 53 | + |
| 54 | +Please follow the [installation](#installation) procedure and then run the following code: |
| 55 | + |
| 56 | +```ruby |
| 57 | +# Load the gem |
| 58 | +require 'openapi_client' |
| 59 | + |
| 60 | +api_instance = OpenapiClient::DeleteApi.new |
| 61 | +opts = { |
| 62 | + delete_request_schema: OpenapiClient::DeleteRequestSchema.new # DeleteRequestSchema | Contains the details of the request message. |
| 63 | +} |
| 64 | + |
| 65 | +begin |
| 66 | + #Used to delete one or more Tokens. The API is limited to 10 Tokens per request. |
| 67 | + result = api_instance.delete_digitization(opts) |
| 68 | + p result |
| 69 | +rescue OpenapiClient::ApiError => e |
| 70 | + puts "Exception when calling DeleteApi->delete_digitization: #{e}" |
| 71 | +end |
| 72 | + |
| 73 | +``` |
| 74 | + |
| 75 | +## Documentation for API Endpoints |
| 76 | + |
| 77 | +All URIs are relative to *https://api.mastercard.com/mdes* |
| 78 | + |
| 79 | +Class | Method | HTTP request | Description |
| 80 | +------------ | ------------- | ------------- | ------------- |
| 81 | +*OpenapiClient::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. |
| 82 | +*OpenapiClient::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. |
| 83 | +*OpenapiClient::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. |
| 84 | +*OpenapiClient::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. |
| 85 | +*OpenapiClient::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. |
| 86 | +*OpenapiClient::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. |
| 87 | +*OpenapiClient::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. |
| 88 | +*OpenapiClient::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. |
| 89 | +*OpenapiClient::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. |
| 90 | +*OpenapiClient::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. |
| 91 | + |
| 92 | + |
| 93 | +## Documentation for Models |
| 94 | + |
| 95 | + - [OpenapiClient::AssetResponseSchema](docs/AssetResponseSchema.md) |
| 96 | + - [OpenapiClient::AuthenticationMethods](docs/AuthenticationMethods.md) |
| 97 | + - [OpenapiClient::BillingAddress](docs/BillingAddress.md) |
| 98 | + - [OpenapiClient::CardInfo](docs/CardInfo.md) |
| 99 | + - [OpenapiClient::CardInfoData](docs/CardInfoData.md) |
| 100 | + - [OpenapiClient::DecisioningData](docs/DecisioningData.md) |
| 101 | + - [OpenapiClient::DeleteRequestSchema](docs/DeleteRequestSchema.md) |
| 102 | + - [OpenapiClient::DeleteResponseSchema](docs/DeleteResponseSchema.md) |
| 103 | + - [OpenapiClient::EncryptedPayload](docs/EncryptedPayload.md) |
| 104 | + - [OpenapiClient::EncryptedPayloadTransact](docs/EncryptedPayloadTransact.md) |
| 105 | + - [OpenapiClient::Error](docs/Error.md) |
| 106 | + - [OpenapiClient::ErrorsResponse](docs/ErrorsResponse.md) |
| 107 | + - [OpenapiClient::GetTaskStatusRequestSchema](docs/GetTaskStatusRequestSchema.md) |
| 108 | + - [OpenapiClient::GetTaskStatusResponseSchema](docs/GetTaskStatusResponseSchema.md) |
| 109 | + - [OpenapiClient::GetTokenRequestSchema](docs/GetTokenRequestSchema.md) |
| 110 | + - [OpenapiClient::GetTokenResponseSchema](docs/GetTokenResponseSchema.md) |
| 111 | + - [OpenapiClient::MediaContent](docs/MediaContent.md) |
| 112 | + - [OpenapiClient::NotifyTokenEncryptedPayload](docs/NotifyTokenEncryptedPayload.md) |
| 113 | + - [OpenapiClient::NotifyTokenUpdatedRequestSchema](docs/NotifyTokenUpdatedRequestSchema.md) |
| 114 | + - [OpenapiClient::NotifyTokenUpdatedResponseSchema](docs/NotifyTokenUpdatedResponseSchema.md) |
| 115 | + - [OpenapiClient::ProductConfig](docs/ProductConfig.md) |
| 116 | + - [OpenapiClient::SearchTokensRequestSchema](docs/SearchTokensRequestSchema.md) |
| 117 | + - [OpenapiClient::SearchTokensResponseSchema](docs/SearchTokensResponseSchema.md) |
| 118 | + - [OpenapiClient::SuspendRequestSchema](docs/SuspendRequestSchema.md) |
| 119 | + - [OpenapiClient::SuspendResponseSchema](docs/SuspendResponseSchema.md) |
| 120 | + - [OpenapiClient::Token](docs/Token.md) |
| 121 | + - [OpenapiClient::TokenDetail](docs/TokenDetail.md) |
| 122 | + - [OpenapiClient::TokenDetailData](docs/TokenDetailData.md) |
| 123 | + - [OpenapiClient::TokenDetailDataPAR](docs/TokenDetailDataPAR.md) |
| 124 | + - [OpenapiClient::TokenDetailTokenizeResponse](docs/TokenDetailTokenizeResponse.md) |
| 125 | + - [OpenapiClient::TokenForLCM](docs/TokenForLCM.md) |
| 126 | + - [OpenapiClient::TokenInfo](docs/TokenInfo.md) |
| 127 | + - [OpenapiClient::TokenizeRequestSchema](docs/TokenizeRequestSchema.md) |
| 128 | + - [OpenapiClient::TokenizeResponseSchema](docs/TokenizeResponseSchema.md) |
| 129 | + - [OpenapiClient::TransactEncryptedData](docs/TransactEncryptedData.md) |
| 130 | + - [OpenapiClient::TransactError](docs/TransactError.md) |
| 131 | + - [OpenapiClient::TransactRequestSchema](docs/TransactRequestSchema.md) |
| 132 | + - [OpenapiClient::TransactResponseSchema](docs/TransactResponseSchema.md) |
| 133 | + - [OpenapiClient::UnSuspendRequestSchema](docs/UnSuspendRequestSchema.md) |
| 134 | + - [OpenapiClient::UnSuspendResponseSchema](docs/UnSuspendResponseSchema.md) |
| 135 | + |
| 136 | + |
| 137 | +## Documentation for Authorization |
| 138 | + |
| 139 | + All endpoints do not require authorization. |
| 140 | + |
0 commit comments