cybersource_rest_client 0.0.83 → 0.0.84

data/lib/cybersource_rest_client/api/instructions_api.rb

@@ -20,7 +20,7 @@ module CyberSource
       @api_client.set_configuration(config)
     end
     # Cancel a purchase intent
-    # Cancels an existing purchase intent identified by the transaction ID.
+    # Cancel an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer decides to abandon the purchase before payment credentials have been used. Requires device information and assurance data for identity verification. Returns status CANCELLED (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required before cancellation can proceed.
     #
     # @param instruction_id 
     # @param agentic_cancel_purchase_intent_request Unique identifier for the purchase intent instruction.
@@ -33,7 +33,7 @@ module CyberSource
     end
 
     # Cancel a purchase intent
-    # Cancels an existing purchase intent identified by the transaction ID.
+    # Cancel an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer decides to abandon the purchase before payment credentials have been used. Requires device information and assurance data for identity verification. Returns status CANCELLED (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required before cancellation can proceed.
     # @param instruction_id 
     # @param agentic_cancel_purchase_intent_request Unique identifier for the purchase intent instruction.
     # @param [Hash] opts the optional parameters
@@ -107,7 +107,7 @@ module CyberSource
       return data, status_code, headers
     end
     # Confirm transaction events
-    # Agents send the confirm transaction events to notify the payment processing is done
+    # Confirm transaction events for a completed purchase. The agent calls this endpoint after the payment has been submitted to notify the Intelligent Commerce Connect of the transaction outcome. The request includes processor information (transaction type, status, approval codes), order details (shipping, tracking, product information), and merchant information. Returns HTTP 202 acknowledging receipt of the confirmation.
     #
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_confirm_transaction_events_request 
@@ -120,7 +120,7 @@ module CyberSource
     end
 
     # Confirm transaction events
-    # Agents send the confirm transaction events to notify the payment processing is done
+    # Confirm transaction events for a completed purchase. The agent calls this endpoint after the payment has been submitted to notify the Intelligent Commerce Connect of the transaction outcome. The request includes processor information (transaction type, status, approval codes), order details (shipping, tracking, product information), and merchant information. Returns HTTP 202 acknowledging receipt of the confirmation.
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_confirm_transaction_events_request 
     # @param [Hash] opts the optional parameters
@@ -194,7 +194,7 @@ module CyberSource
       return data, status_code, headers
     end
     # Initiate a purchase intent
-    # Creates a new purchase intent with the provided details.
+    # Create a new purchase intent (instruction) for an agentic transaction. The agent calls this endpoint after a card has been enrolled to define what the consumer wants to buy. The request includes payment instrument references, device and assurance data, mandates (spending limits, merchant preferences, and product descriptions), and optional buyer information. Return an instructionId (HTTP 200) if the intent is created immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. The instructionId returned is used in all subsequent operations - update, cancel, retrieve credentials, and confirm transaction.
     #
     # @param agentic_create_purchase_intent_request 
     # @param [Hash] opts the optional parameters
@@ -206,7 +206,7 @@ module CyberSource
     end
 
     # Initiate a purchase intent
-    # Creates a new purchase intent with the provided details.
+    # Create a new purchase intent (instruction) for an agentic transaction. The agent calls this endpoint after a card has been enrolled to define what the consumer wants to buy. The request includes payment instrument references, device and assurance data, mandates (spending limits, merchant preferences, and product descriptions), and optional buyer information. Return an instructionId (HTTP 200) if the intent is created immediately, or PENDING (HTTP 202) with pendingEvents if cardholder authentication is required. The instructionId returned is used in all subsequent operations - update, cancel, retrieve credentials, and confirm transaction.
     # @param agentic_create_purchase_intent_request 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AgenticCreatePurchaseIntentResponse200, Fixnum, Hash)>] AgenticCreatePurchaseIntentResponse200 data, response status code and response headers
@@ -275,7 +275,7 @@ module CyberSource
       return data, status_code, headers
     end
     # Retrieve payment credentials
-    # Retrieve a customer's tokenized payment credentials to complete the transaction.
+    # Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant. The agent calls this endpoint after a purchase intent has been created and approved, providing transaction-level details including order information, merchant details, payment options, and production information. Returns COMPLETED (HTTP 200) with a signed payload containing encrypted payment credentials (authorization token and JWS-signed payload), or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required. The signed payload is used by the merchant's payment processor to complete the transaction.
     #
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_retrieve_payment_credentials_request 
@@ -288,7 +288,7 @@ module CyberSource
     end
 
     # Retrieve payment credentials
-    # Retrieve a customer&#39;s tokenized payment credentials to complete the transaction.
+    # Retrieve tokenized payment credentials for a purchase intent to complete the transaction at a merchant. The agent calls this endpoint after a purchase intent has been created and approved, providing transaction-level details including order information, merchant details, payment options, and production information. Returns COMPLETED (HTTP 200) with a signed payload containing encrypted payment credentials (authorization token and JWS-signed payload), or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required. The signed payload is used by the merchant&#39;s payment processor to complete the transaction.
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_retrieve_payment_credentials_request 
     # @param [Hash] opts the optional parameters
@@ -362,7 +362,7 @@ module CyberSource
       return data, status_code, headers
     end
     # Update a purchase intent
-    # Updates an existing purchase intent identified by the transaction ID.
+    # Update an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer modifies their order — for example, changing the quantity, updating mandates, switching payment instruments, or changing shipping details. The request body has the same structure as the initiate request. Returns the same instructionId (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required for the updated intent.
     #
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_update_purchase_intent_request 
@@ -375,7 +375,7 @@ module CyberSource
     end
 
     # Update a purchase intent
-    # Updates an existing purchase intent identified by the transaction ID.
+    # Update an existing purchase intent (instruction) identified by its instructionId. The agent calls this endpoint when the consumer modifies their order — for example, changing the quantity, updating mandates, switching payment instruments, or changing shipping details. The request body has the same structure as the initiate request. Returns the same instructionId (HTTP 200) on success, or PENDING (HTTP 202) with pendingEvents if additional cardholder authentication is required for the updated intent.
     # @param instruction_id Unique identifier for the purchase intent instruction.
     # @param agentic_update_purchase_intent_request 
     # @param [Hash] opts the optional parameters

data/lib/cybersource_rest_client/api/instrument_identifier_api.rb

@@ -202,7 +202,7 @@ module CyberSource
     # @option opts [BOOLEAN] :retrieve_bin_details Retrieve the Bin Details of PAN or network token
     # @option opts [Integer] :offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (default to 0)
     # @option opts [Integer] :limit 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. (default to 20)
-    # @return [PaymentInstrumentList1]
+    # @return [PaymentInstrumentList]
     #
     def get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {})
       data, status_code, headers = get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts)
@@ -217,7 +217,7 @@ module CyberSource
     # @option opts [BOOLEAN] :retrieve_bin_details Retrieve the Bin Details of PAN or network token
     # @option opts [Integer] :offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
     # @option opts [Integer] :limit 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.
-    # @return [Array<(PaymentInstrumentList1, Fixnum, Hash)>] PaymentInstrumentList1 data, response status code and response headers
+    # @return [Array<(PaymentInstrumentList, Fixnum, Hash)>] PaymentInstrumentList data, response status code and response headers
     def get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {})
 
       if @api_client.config.debugging
@@ -276,7 +276,7 @@ module CyberSource
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PaymentInstrumentList1',
+        :return_type => 'PaymentInstrumentList',
         :isResponseMLEForApi => is_response_mle_for_api)
       if @api_client.config.debugging
         begin

data/lib/cybersource_rest_client/api/manage_webhooks_api.rb

@@ -59,7 +59,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -141,7 +141,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -231,7 +231,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -314,7 +314,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -399,7 +399,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -482,7 +482,7 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
 
@@ -525,27 +525,27 @@ module CyberSource
     # Message Level Encryption
     # Store and manage certificates that will be used to preform Message Level Encryption (MLE). Each new webhook will need its own unique asymmetric certificate. You can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide. 
     #
-    # @param v_c_sender_organization_id Sender organization id
-    # @param v_c_permissions Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
     # @param save_asym_egress_key Provide egress Asymmetric key information to save (create or store)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :v_c_correlation_id A globally unique id associated with your request
+    # @option opts [String] :v_c_sender_organization_id Sender organization id
+    # @option opts [String] :v_c_permissions Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
     # @return [InlineResponse2018]
     #
-    def save_asym_egress_key(v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, opts = {})
-      data, status_code, headers = save_asym_egress_key_with_http_info(v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, opts)
+    def save_asym_egress_key(save_asym_egress_key, opts = {})
+      data, status_code, headers = save_asym_egress_key_with_http_info(save_asym_egress_key, opts)
       return data, status_code, headers
     end
 
     # Message Level Encryption
     # Store and manage certificates that will be used to preform Message Level Encryption (MLE). Each new webhook will need its own unique asymmetric certificate. You can either use a digital certificate issued/signed by a CA or self-sign your own using the documentation available on the Developer Guide. 
-    # @param v_c_sender_organization_id Sender organization id
-    # @param v_c_permissions Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
     # @param save_asym_egress_key Provide egress Asymmetric key information to save (create or store)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :v_c_correlation_id A globally unique id associated with your request
+    # @option opts [String] :v_c_sender_organization_id Sender organization id
+    # @option opts [String] :v_c_permissions Encoded user permissions returned by the CGK, for the entity user who initiated the boarding
     # @return [Array<(InlineResponse2018, Fixnum, Hash)>] InlineResponse2018 data, response status code and response headers
-    def save_asym_egress_key_with_http_info(v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, opts = {})
+    def save_asym_egress_key_with_http_info(save_asym_egress_key, opts = {})
 
       if @api_client.config.debugging
           begin
@@ -555,18 +555,6 @@ module CyberSource
                 puts 'Cannot write to log'
             end
       end
-      # verify the required parameter 'v_c_sender_organization_id' is set
-      if @api_client.config.client_side_validation && v_c_sender_organization_id.nil?
-        fail ArgumentError, "Missing the required parameter 'v_c_sender_organization_id' when calling ManageWebhooksApi.save_asym_egress_key"
-      end
-      #if @api_client.config.client_side_validation && v_c_sender_organization_id !~ Regexp.new(/^[A-Za-z0-9\\-_]+$/)
-        #fail ArgumentError, "invalid value for 'v_c_sender_organization_id' when calling ManageWebhooksApi.save_asym_egress_key, must conform to the pattern /^[A-Za-z0-9\\-_]+$/."
-      #end
-
-      # verify the required parameter 'v_c_permissions' is set
-      if @api_client.config.client_side_validation && v_c_permissions.nil?
-        fail ArgumentError, "Missing the required parameter 'v_c_permissions' when calling ManageWebhooksApi.save_asym_egress_key"
-      end
       # verify the required parameter 'save_asym_egress_key' is set
       if @api_client.config.client_side_validation && save_asym_egress_key.nil?
         fail ArgumentError, "Missing the required parameter 'save_asym_egress_key' when calling ManageWebhooksApi.save_asym_egress_key"
@@ -575,6 +563,10 @@ module CyberSource
         #fail ArgumentError, "invalid value for 'opts[:\"v_c_correlation_id\"]' when calling ManageWebhooksApi.save_asym_egress_key, must conform to the pattern /^[A-Za-z0-9\\.\\-_:]+$/."
       #end
 
+      #if @api_client.config.client_side_validation && !opts[:'v_c_sender_organization_id'].nil? && opts[:'v_c_sender_organization_id'] !~ Regexp.new(/^[A-Za-z0-9\\-_]+$/)
+        #fail ArgumentError, "invalid value for 'opts[:\"v_c_sender_organization_id\"]' when calling ManageWebhooksApi.save_asym_egress_key, must conform to the pattern /^[A-Za-z0-9\\-_]+$/."
+      #end
+
       # resource path
       local_var_path = 'kms/egress/v2/keys-asym'
 
@@ -584,12 +576,12 @@ module CyberSource
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
-      header_params[:'v-c-sender-organization-id'] = v_c_sender_organization_id
-      header_params[:'v-c-permissions'] = v_c_permissions
       header_params[:'v-c-correlation-id'] = opts[:'v_c_correlation_id'] if !opts[:'v_c_correlation_id'].nil?
+      header_params[:'v-c-sender-organization-id'] = opts[:'v_c_sender_organization_id'] if !opts[:'v_c_sender_organization_id'].nil?
+      header_params[:'v-c-permissions'] = opts[:'v_c_permissions'] if !opts[:'v_c_permissions'].nil?
 
       # form parameters
       form_params = {}