Merge pull request #119 from CyberSource/release-jan25

spec changes
CyberSource · Feb 5, 2025 · 84c4171 · 84c4171
2 parents 0733461 + e160099
commit 84c4171
Show file tree

Hide file tree

Showing 287 changed files with 22,093 additions and 9,395 deletions.
diff --git a/cybersource_rest_client.gemspec b/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.68"
+  s.version     = "0.0.69"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["CyberSource"]
   s.email       = ["[email protected]"]

diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **risk_information** | [**Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) |  | [optional] 
 **acquirer_information** | [**Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) |  | [optional] 
 **recurring_payment_information** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) |  | [optional] 
+**unscheduled_payment_information** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) |  | [optional] 
 **hosted_payment_information** | [**Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) |  | [optional] 
 **watchlist_screening_information** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) |  | [optional] 
 

diff --git a/docs/GenerateCaptureContextRequest.md b/docs/GenerateCaptureContextRequest.md
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_version** | **String** | Specify the version of Microform that you want to use.  | [optional] 
 **target_origins** | **Array&lt;String&gt;** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used).    You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported.  Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc)  Examples:   - https://example.com   - https://subdomain.example.com   - https://example.com:8080&lt;br&gt;&lt;br&gt;  If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:    targetOrigins: [     \&quot;https://example.com\&quot;,     \&quot;https://basket.example.com\&quot;,     \&quot;https://ecom.example.com\&quot;   ]  | [optional] 
-**allowed_card_networks** | **Array&lt;String&gt;** | The list of card networks you want to use for this Microform transaction.  Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA  | [optional] 
-**checkout_api_initialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) |  | [optional] 
+**allowed_card_networks** | **Array&lt;String&gt;** | The list of card networks you want to use for this Microform transaction.  Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA  **Important:**    - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.   - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request.   - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request.  | [optional] 
+**allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant.    Possible values when launching Microform: - CARD - CHECK &lt;br&gt;&lt;br&gt;  | [optional] 
 
 
diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
@@ -6,11 +6,10 @@ Name | Type | Description | Notes
 **client_version** | **String** | Specify the version of Unified Checkout that you want to use. | [optional] 
 **target_origins** | **Array&lt;String&gt;** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used).    You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported.  Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc)  Examples:   - https://example.com   - https://subdomain.example.com   - https://example.com:8080&lt;br&gt;&lt;br&gt;  If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:    targetOrigins: [     \&quot;https://example.com\&quot;,     \&quot;https://basket.example.com\&quot;,     \&quot;https://ecom.example.com\&quot;   ]  | [optional] 
 **allowed_card_networks** | **Array&lt;String&gt;** | The list of card networks you want to use for this Unified Checkout transaction.  Unified Checkout currently supports the following card networks:     - VISA     - MASTERCARD     - AMEX     - CARNET     - CARTESBANCAIRES     - CUP     - DINERSCLUB     - DISCOVER     - EFTPOS     - ELO     - JCB     - JCREW     - MADA     - MAESTRO     - MEEZA  | [optional] 
-**allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant.    Possible values when launching Unified Checkout:   - PANENTRY                 - GOOGLEPAY   - SRC   - CHECK &lt;br&gt;&lt;br&gt;  Possible values when launching Unified Checkout with Checkout API: - PANENTRY               - SRC &lt;br&gt;&lt;br&gt;  Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt;  **Important:**    - SRC and CLICKTOPAY are only available for Visa, Mastercard and AMEX.  | [optional] 
+**allowed_payment_types** | **Array&lt;String&gt;** | The payment types that are allowed for the merchant.    Possible values when launching Unified Checkout:   - APPLEPAY   - CHECK   - CLICKTOPAY   - GOOGLEPAY   - PANENTRY                 - PAZE &lt;br&gt;&lt;br&gt;  Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY &lt;br&gt;&lt;br&gt;  **Important:**    - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.   - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests.  Click to Pay uses Click to Pay token requester IDs and not the merchant&#39;s existing token requester.   - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.  | [optional] 
 **country** | **String** | Country the purchase is originating from (e.g. country of the merchant).  Use the two-character ISO Standard  | [optional] 
 **locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code.  Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)  | [optional] 
 **capture_mandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) |  | [optional] 
 **order_information** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) |  | [optional] 
-**checkout_api_initialization** | [**Upv1capturecontextsCheckoutApiInitialization**](Upv1capturecontextsCheckoutApiInitialization.md) |  | [optional] 
 
 
diff --git a/docs/InlineResponse2011.md b/docs/InlineResponse2011.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 **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: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; 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] 
+**payment_account_information** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) |  | [optional] 
+**issuer_information** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) |  | [optional] 
 **payout_information** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) |  | [optional] 
 
 
diff --git a/docs/InlineResponse2011PaymentAccountInformation.md b/docs/InlineResponse2011PaymentAccountInformation.md
diff --git a/docs/InstrumentIdentifierApi.md b/docs/InstrumentIdentifierApi.md
@@ -79,7 +79,8 @@ api_instance = CyberSource::InstrumentIdentifierApi.new
 instrument_identifier_id = 'instrument_identifier_id_example' # String | The Id of an Instrument Identifier.
 
 opts = { 
-  profile_id: 'profile_id_example' # String | The Id of a profile containing user specific TMS configuration.
+  profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true # BOOLEAN | Retrieve the Bin Details of PAN or network token
 }
 
 begin
@@ -97,6 +98,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **instrument_identifier_id** | **String**| The Id of an Instrument Identifier. | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
 
 ### Return type
 
@@ -131,6 +133,7 @@ instrument_identifier_id = 'instrument_identifier_id_example' # String | The Id
 
 opts = { 
   profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true, # BOOLEAN | Retrieve the Bin Details of PAN or network token
   offset: 0, # Integer | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
   limit: 20 # Integer | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.
 }
@@ -150,6 +153,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **instrument_identifier_id** | **String**| The Id of an Instrument Identifier. | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
  **offset** | **Integer**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
  **limit** | **Integer**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20]
 
@@ -188,6 +192,7 @@ patch_instrument_identifier_request = CyberSource::PatchInstrumentIdentifierRequ
 
 opts = { 
   profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true, # BOOLEAN | Retrieve the Bin Details of PAN or network token
   if_match: 'if_match_example' # String | Contains an ETag value from a GET request to make the request conditional.
 }
 
@@ -207,6 +212,7 @@ Name | Type | Description  | Notes
  **instrument_identifier_id** | **String**| The Id of an Instrument Identifier. | 
  **patch_instrument_identifier_request** | [**PatchInstrumentIdentifierRequest**](PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
  **if_match** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional] 
 
 ### Return type
@@ -241,7 +247,8 @@ api_instance = CyberSource::InstrumentIdentifierApi.new
 post_instrument_identifier_request = CyberSource::PostInstrumentIdentifierRequest.new # PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
 
 opts = { 
-  profile_id: 'profile_id_example' # String | The Id of a profile containing user specific TMS configuration.
+  profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true # BOOLEAN | Retrieve the Bin Details of PAN or network token
 }
 
 begin
@@ -259,6 +266,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **post_instrument_identifier_request** | [**PostInstrumentIdentifierRequest**](PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
 
 ### Return type
 

diff --git a/docs/Microformv2sessionsCheckoutApiInitialization.md b/docs/Microformv2sessionsCheckoutApiInitialization.md
diff --git a/docs/OctCreatePaymentRequest.md b/docs/OctCreatePaymentRequest.md
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **sender_information** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) |  | [optional] 
 **processing_information** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) |  | [optional] 
 **payment_information** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) |  | [optional] 
+**aggregator_information** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) |  | [optional] 
 
 
diff --git a/docs/PatchInstrumentIdentifierRequest.md b/docs/PatchInstrumentIdentifierRequest.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **processing_information** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) |  | [optional] 
 **bill_to** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) |  | [optional] 
 **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) |  | [optional] 
+**_embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) |  | [optional] 
 
 
diff --git a/docs/PaymentInstrumentApi.md b/docs/PaymentInstrumentApi.md
@@ -77,7 +77,8 @@ api_instance = CyberSource::PaymentInstrumentApi.new
 payment_instrument_id = 'payment_instrument_id_example' # String | The Id of a payment instrument.
 
 opts = { 
-  profile_id: 'profile_id_example' # String | The Id of a profile containing user specific TMS configuration.
+  profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true # BOOLEAN | Retrieve the Bin Details of PAN or network token
 }
 
 begin
@@ -95,6 +96,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **payment_instrument_id** | **String**| The Id of a payment instrument. | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
 
 ### Return type
 
@@ -131,6 +133,7 @@ patch_payment_instrument_request = CyberSource::PatchPaymentInstrumentRequest.ne
 
 opts = { 
   profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true, # BOOLEAN | Retrieve the Bin Details of PAN or network token
   if_match: 'if_match_example' # String | Contains an ETag value from a GET request to make the request conditional.
 }
 
@@ -150,6 +153,7 @@ Name | Type | Description  | Notes
  **payment_instrument_id** | **String**| The Id of a payment instrument. | 
  **patch_payment_instrument_request** | [**PatchPaymentInstrumentRequest**](PatchPaymentInstrumentRequest.md)|  | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
  **if_match** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional] 
 
 ### Return type
@@ -184,7 +188,8 @@ api_instance = CyberSource::PaymentInstrumentApi.new
 post_payment_instrument_request = CyberSource::PostPaymentInstrumentRequest.new # PostPaymentInstrumentRequest | 
 
 opts = { 
-  profile_id: 'profile_id_example' # String | The Id of a profile containing user specific TMS configuration.
+  profile_id: 'profile_id_example', # String | The Id of a profile containing user specific TMS configuration.
+  retrieve_bin_details: true # BOOLEAN | Retrieve the Bin Details of PAN or network token
 }
 
 begin
@@ -202,6 +207,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **post_payment_instrument_request** | [**PostPaymentInstrumentRequest**](PostPaymentInstrumentRequest.md)|  | 
  **profile_id** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] 
+ **retrieve_bin_details** | **BOOLEAN**| Retrieve the Bin Details of PAN or network token | [optional] 
 
 ### Return type
 

diff --git a/docs/PostInstrumentIdentifierEnrollmentRequest.md b/docs/PostInstrumentIdentifierEnrollmentRequest.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **processing_information** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) |  | [optional] 
 **bill_to** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) |  | [optional] 
 **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) |  | [optional] 
+**_embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) |  | [optional] 
 
 
diff --git a/docs/PostInstrumentIdentifierRequest.md b/docs/PostInstrumentIdentifierRequest.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
 **processing_information** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) |  | [optional] 
 **bill_to** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) |  | [optional] 
 **metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) |  | [optional] 
+**_embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) |  | [optional]