Merge pull request #113 from CyberSource/july24-release

july24 spec changes

cybersource_rest_client.gemspec

@@ -17,7 +17,7 @@ require "cybersource_rest_client/version"
 
 Gem::Specification.new do |s|
   s.name        = "cybersource_rest_client"
-  s.version     = "0.0.63"
+  s.version     = "0.0.64"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["CyberSource"]
   s.email       = ["[email protected]"]

docs/BinLookupApi.md

@@ -0,0 +1,56 @@
+# CyberSource::BinLookupApi
+
+All URIs are relative to *https://apitest.cybersource.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_info**](BinLookupApi.md#get_account_info) | **POST** /bin/v1/binlookup | BIN Lookup API
+
+
+# **get_account_info**
+> InlineResponse2011 get_account_info(create_bin_lookup_request)
+
+BIN Lookup API
+
+The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses  with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant. 
+
+### Example
+```ruby
+# load the gem
+require 'cybersource_rest_client'
+
+api_instance = CyberSource::BinLookupApi.new
+
+create_bin_lookup_request = CyberSource::CreateBinLookupRequest.new # CreateBinLookupRequest | 
+
+
+begin
+  #BIN Lookup API
+  result = api_instance.get_account_info(create_bin_lookup_request)
+  p result
+rescue CyberSource::ApiError => e
+  puts "Exception when calling BinLookupApi->get_account_info: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_bin_lookup_request** | [**CreateBinLookupRequest**](CreateBinLookupRequest.md)|  | 
+
+### Return type
+
+[**InlineResponse2011**](InlineResponse2011.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json;charset=utf-8
+ - **Accept**: application/hal+json;charset=utf-8
+
+
+

docs/TssV2TransactionsPost400Response.md → docs/BinLookupv400Response.md

@@ -1,4 +1,4 @@
-# CyberSource::TssV2TransactionsPost400Response
+# CyberSource::BinLookupv400Response
 
 ## Properties
 Name | Type | Description | Notes

docs/Binv1binlookupClientReferenceInformation.md

@@ -0,0 +1,11 @@
+# CyberSource::Binv1binlookupClientReferenceInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) |  | [optional] 
+**application_name** | **String** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.  | [optional] 
+**application_version** | **String** | Version of the CyberSource application or integration used for a transaction.  | [optional] 
+**application_user** | **String** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.  | [optional] 
+
+

docs/Binv1binlookupPaymentInformation.md

@@ -0,0 +1,11 @@
+# CyberSource::Binv1binlookupPaymentInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card** | [**Binv1binlookupPaymentInformationCard**](Binv1binlookupPaymentInformationCard.md) |  | [optional] 
+**customer** | [**GetAllSubscriptionsResponsePaymentInformationCustomer**](GetAllSubscriptionsResponsePaymentInformationCustomer.md) |  | [optional] 
+**payment_instrument** | [**Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) |  | [optional] 
+**instrument_identifier** | [**Ptsv2paymentsPaymentInformationInstrumentIdentifier**](Ptsv2paymentsPaymentInformationInstrumentIdentifier.md) |  | [optional] 
+
+

docs/Binv1binlookupPaymentInformationCard.md

@@ -0,0 +1,8 @@
+# CyberSource::Binv1binlookupPaymentInformationCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers.  #### FDMS Nashville Required. String (19)  #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.  #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.  | [optional] 
+
+

docs/Binv1binlookupProcessingInformation.md

@@ -0,0 +1,9 @@
+# CyberSource::Binv1binlookupProcessingInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bin_source** | **String** | Bin Source File Identifier.  Possible values: - itmx - rupay  | [optional] 
+**payout_options** | [**Binv1binlookupProcessingInformationPayoutOptions**](Binv1binlookupProcessingInformationPayoutOptions.md) |  | [optional] 
+
+

docs/Binv1binlookupProcessingInformationPayoutOptions.md

@@ -0,0 +1,10 @@
+# CyberSource::Binv1binlookupProcessingInformationPayoutOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_inquiry** | **BOOLEAN** | If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup.  Possible values: - true - false  | [optional] 
+**network_id** | **String** | The networks specified in this field must be a subset of the information provided during program enrollment    Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS  | [optional] 
+**acquirer_bin** | **String** | BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment.  | [optional] 
+
+

docs/Binv1binlookupTokenInformation.md

@@ -0,0 +1,9 @@
+# CyberSource::Binv1binlookupTokenInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jti** | **String** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV).  | [optional] 
+**transient_token_jwt** | **String** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result.  | [optional] 
+
+

docs/CreateBinLookupRequest.md

@@ -0,0 +1,11 @@
+# CyberSource::CreateBinLookupRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_reference_information** | [**Binv1binlookupClientReferenceInformation**](Binv1binlookupClientReferenceInformation.md) |  | [optional] 
+**payment_information** | [**Binv1binlookupPaymentInformation**](Binv1binlookupPaymentInformation.md) |  | [optional] 
+**token_information** | [**Binv1binlookupTokenInformation**](Binv1binlookupTokenInformation.md) |  | [optional] 
+**processing_information** | [**Binv1binlookupProcessingInformation**](Binv1binlookupProcessingInformation.md) |  | [optional] 
+
+

docs/CreateNewWebhooksApi.md

@@ -10,7 +10,7 @@ Method | HTTP request | Description
 
 
 # **create_webhook_subscription**
-> InlineResponse2013 create_webhook_subscription(opts)
+> InlineResponse2014 create_webhook_subscription(opts)
 
 Create a Webhook
 
@@ -44,7 +44,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2013**](InlineResponse2013.md)
+[**InlineResponse2014**](InlineResponse2014.md)
 
 ### Authorization
 
@@ -105,7 +105,7 @@ No authorization required
 
 
 # **save_sym_egress_key**
-> InlineResponse2012 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, opts)
+> InlineResponse2013 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, opts)
 
 Create Webhook Security Keys
 
@@ -147,7 +147,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2012**](InlineResponse2012.md)
+[**InlineResponse2013**](InlineResponse2013.md)
 
 ### Authorization
 

docs/InlineResponse2002.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **integration_information** | [**InlineResponse2002IntegrationInformation**](InlineResponse2002IntegrationInformation.md) |  | [optional] 
 **organization_information** | [**Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) |  | [optional] 
 **product_information** | [**Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) |  | [optional] 
-**product_information_setups** | [**Array<InlineResponse2011ProductInformationSetups>**](InlineResponse2011ProductInformationSetups.md) |  | [optional] 
+**product_information_setups** | [**Array<InlineResponse2012ProductInformationSetups>**](InlineResponse2012ProductInformationSetups.md) |  | [optional] 
 **document_information** | [**Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) |  | [optional] 
 **details** | **Hash<String, Array<Object>>** |  | [optional] 
 

docs/InlineResponse2011.md

@@ -3,14 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**submit_time_utc** | **Date** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`  Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.  | [optional] 
-**status** | **String** | The status of Registration request Possible Values:   - 'INITIALIZED'   - 'RECEIVED'   - 'PROCESSING'   - 'SUCCESS'   - 'FAILURE'   - 'PARTIAL'  | [optional] 
-**registration_information** | [**InlineResponse2011RegistrationInformation**](InlineResponse2011RegistrationInformation.md) |  | [optional] 
-**integration_information** | [**InlineResponse2011IntegrationInformation**](InlineResponse2011IntegrationInformation.md) |  | [optional] 
-**organization_information** | [**InlineResponse2011OrganizationInformation**](InlineResponse2011OrganizationInformation.md) |  | [optional] 
-**product_information_setups** | [**Array<InlineResponse2011ProductInformationSetups>**](InlineResponse2011ProductInformationSetups.md) |  | [optional] 
-**message** | **String** |  | [optional] 
-**details** | **Hash<String, Array<Object>>** |  | [optional] 
+**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.  | [optional] 
+**submit_time_utc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC.  Returned by Cybersource for all services.  | [optional] 
+**status** | **String** | The status of the submitted transaction.  Possible values:  - COMPLETED  - MULTIPLE  - NO MATCH  | [optional] 
+**payment_account_information** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) |  | [optional] 
+**issuer_information** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) |  | [optional] 
+**payout_information** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) |  | [optional] 
 
 

docs/InlineResponse2011IssuerInformation.md

@@ -0,0 +1,12 @@
+# CyberSource::InlineResponse2011IssuerInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | This field contains the issuer name.  | [optional] 
+**country** | **String** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.  | [optional] 
+**bin_length** | **String** | This field contains the length of the BIN.  | [optional] 
+**account_prefix** | **String** | This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).  | [optional] 
+**phone_number** | **String** | This field contains the customer service phone number for the issuer.  | [optional] 
+
+

docs/InlineResponse2011PaymentAccountInformation.md

@@ -0,0 +1,10 @@
+# CyberSource::InlineResponse2011PaymentAccountInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card** | [**InlineResponse2011PaymentAccountInformationCard**](InlineResponse2011PaymentAccountInformationCard.md) |  | [optional] 
+**features** | [**InlineResponse2011PaymentAccountInformationFeatures**](InlineResponse2011PaymentAccountInformationFeatures.md) |  | [optional] 
+**network** | [**InlineResponse2011PaymentAccountInformationNetwork**](InlineResponse2011PaymentAccountInformationNetwork.md) |  | [optional] 
+
+

docs/InlineResponse2011PaymentAccountInformationCard.md

@@ -0,0 +1,13 @@
+# CyberSource::InlineResponse2011PaymentAccountInformationCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | This field contains the 3-digit value that indicates the card type.  Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras  [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.  [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.  [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.  | [optional] 
+**brand_name** | **String** | This field contains the card brand name.   Some of the possible values (not an exhaustive list) are -    - VISA   - MASTERCARD   - AMERICAN EXPRESS   - DISCOVER   - DINERS CLUB   - CARTE BLANCHE   - JCB   - OPTIMA   - TWINPAY CREDIT CARD   - TWINPAY DEBIT CARD   - WALMART   - ENROUTE   - LOWES CONSUMER   - HOME DEPOT CONSUMER   - MBNA   - DICKS SPORTWEAR   - CASUAL CORNER   - SEARS   - JAL   - DISNEY CARD   - SWITCH/SOLO   - SAMS CLUB CONSUMER   - SAMS CLUB BUSINESS   - NICOS HOUSE CARD   - BEBE   - RESTORATION HARDWARE   - DELTA ONLINE   - SOLO   - VISA ELECTRON   - DANKORT   - LASER   - CARTE BANCAIRE   - CARTA SI   - ENCODED ACCOUNT   - UATP   - HOUSEHOLD   - MAESTRO   - GE CAPITAL   - KOREAN CARDS   - STYLE CARDS   - JCREW   - MEIJER   - HIPERCARD   - AURA   - REDECARD   - ORICO HOUSE CARD   - ELO   - CAPITAL ONE PRIVATE LABEL   - CARNET   - RUPAY   - CHINA UNION PAY   - FALABELLA PRIVATE LABEL   - PROMPTCARD   - KOREAN DOMESTIC   - BANRICOMPRAS  | [optional] 
+**currency** | **String** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.  | [optional] 
+**max_length** | **String** | This field contains the max length of the card.  | [optional] 
+**credential_type** | **String** | This field contains the type of the payment credential. Possible values:   - PAN   - TOKEN   | [optional] 
+**brands** | [**Array<InlineResponse2011PaymentAccountInformationCardBrands>**](InlineResponse2011PaymentAccountInformationCardBrands.md) | Array of brands | [optional] 
+
+