ultracart_api 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3571f0ec8610fbde0a62eb2cb17fa6e9802f2ff064679c54c7d9c649f0c482
-  data.tar.gz: 289b61ace54ba132d60741bb4409a16c76604f62cb931b217fd49d6983547311
+  metadata.gz: f6262d882ea4fe642d39f1e6e1f5a8b1429b0153d7eccd18bb3cfb36a2eb8c81
+  data.tar.gz: 6b8f0ef3ae1dccde014b2e3c95f9a73338762546def0aa120cd9c6e8f94a36e4
 SHA512:
-  metadata.gz: 916db9822b8d7957d5d9dbe6a223b3a134c583c398600361397c87333a12d7a3f0ca10f114b17a82d57d3efa1d14d71f8d5abb374e197d6878d2e53f3b62de7b
-  data.tar.gz: 785bdb0b07363f5b2d0abf32a0a6f4493f3e0b307f3aee5d02922a0003ae87eabe64733212b04488008be1bce362d98b4106cdb0ef3ad484af3f122331c925aa
+  metadata.gz: 382574e46088303307cf2b9848583a3abe57051b4145d78d876eecfcbdfb456fac79132a345aba40715d2a72630348ca564575c506a80427706da9217ba03dcd
+  data.tar.gz: 9a8ba86ad0f93ade42fe090d8c5621556dd3c7811e7db4a5cf7078f59e39a1d2b9413e36985e33a809f4237a69e41cf2f74625450a37c891e9896072c267c4af

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.5.0
+- Package version: 3.5.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.5.0.gem
+gem install ./ultracart_api-3.5.1.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.5.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.5.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.5.0'
+    gem 'ultracart_api', '~> 3.5.1'
 
 ### Install from Git
 
@@ -344,6 +344,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**search_shared_items**](docs/StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
 *UltracartClient::StorefrontApi* | [**send_email_test**](docs/StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
 *UltracartClient::StorefrontApi* | [**send_postcard_test**](docs/StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
+*UltracartClient::StorefrontApi* | [**send_webhook_test**](docs/StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
 *UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
 *UltracartClient::StorefrontApi* | [**subscribe_to_email_list**](docs/StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
 *UltracartClient::StorefrontApi* | [**unfavorite_screen_recording**](docs/StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
@@ -640,6 +641,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
  - [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
  - [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
+ - [UltracartClient::EmailCommseqWebhookSendTestRequest](docs/EmailCommseqWebhookSendTestRequest.md)
  - [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
  - [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
  - [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
@@ -1114,6 +1116,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.5.1 | 08/11/2021 | email webhook test method | 
 | 3.5.0 | 08/11/2021 | RestOrderChannelPartner.store_completed was incorrectly defaulting to true | 
 | 3.4.13 | 08/10/2021 | configuration api - changed some field types form string to number | 
 | 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui  | 

data/docs/EmailCommseqWebhookSendTestRequest.md

@@ -0,0 +1,14 @@
+# UltracartClient::EmailCommseqWebhookSendTestRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cart_id** | **String** |  | [optional] 
+**cart_item_ids** | **Array<String>** |  | [optional] 
+**email** | **String** |  | [optional] 
+**esp_commseq_step_uuid** | **String** |  | [optional] 
+**esp_commseq_uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+
+

data/docs/StorefrontApi.md

@@ -134,6 +134,7 @@ Method | HTTP request | Description
 [**search_shared_items**](StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
 [**send_email_test**](StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
 [**send_postcard_test**](StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
+[**send_webhook_test**](StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
 [**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
 [**subscribe_to_email_list**](StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
 [**unfavorite_screen_recording**](StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
@@ -6851,6 +6852,57 @@ Name | Type | Description  | Notes
 
 
 
+# **send_webhook_test**
+> EmailCommseqEmailSendTestResponse send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
+
+Send webhook test
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+email_commseq_webhook_test_request = UltracartClient::EmailCommseqWebhookSendTestRequest.new # EmailCommseqWebhookSendTestRequest | Email commseq webhook test request
+
+
+begin
+  #Send webhook test
+  result = api_instance.send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->send_webhook_test: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **email_commseq_webhook_test_request** | [**EmailCommseqWebhookSendTestRequest**](EmailCommseqWebhookSendTestRequest.md)| Email commseq webhook test request | 
+
+### Return type
+
+[**EmailCommseqEmailSendTestResponse**](EmailCommseqEmailSendTestResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **start_email_campaign**
 > BaseResponse start_email_campaign(storefront_oid, email_campaign_uuid)
 

data/lib/ultracart_api.rb

@@ -238,6 +238,7 @@ require 'ultracart_api/models/email_commseq_stat_response'
 require 'ultracart_api/models/email_commseq_step'
 require 'ultracart_api/models/email_commseq_step_log'
 require 'ultracart_api/models/email_commseq_step_logs_response'
+require 'ultracart_api/models/email_commseq_webhook_send_test_request'
 require 'ultracart_api/models/email_commseqs_response'
 require 'ultracart_api/models/email_customer'
 require 'ultracart_api/models/email_customer_editor_url_response'

data/lib/ultracart_api/api/storefront_api.rb

@@ -7661,6 +7661,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Send webhook test
+    # @param storefront_oid 
+    # @param email_commseq_webhook_test_request Email commseq webhook test request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailSendTestResponse]
+    def send_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {})
+      data, _status_code, _headers = send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts)
+      data
+    end
+
+    # Send webhook test
+    # @param storefront_oid 
+    # @param email_commseq_webhook_test_request Email commseq webhook test request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailSendTestResponse, Fixnum, Hash)>] EmailCommseqEmailSendTestResponse data, response status code and response headers
+    def send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.send_webhook_test ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_webhook_test"
+      end
+      # verify the required parameter 'email_commseq_webhook_test_request' is set
+      if @api_client.config.client_side_validation && email_commseq_webhook_test_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_webhook_test_request' when calling StorefrontApi.send_webhook_test"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/webhooks/test'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(email_commseq_webhook_test_request)
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailCommseqEmailSendTestResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#send_webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Start email campaign
     # @param storefront_oid 
     # @param email_campaign_uuid 

data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb

@@ -0,0 +1,240 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class EmailCommseqWebhookSendTestRequest
+    attr_accessor :cart_id
+
+    attr_accessor :cart_item_ids
+
+    attr_accessor :email
+
+    attr_accessor :esp_commseq_step_uuid
+
+    attr_accessor :esp_commseq_uuid
+
+    attr_accessor :name
+
+    attr_accessor :order_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cart_id' => :'cart_id',
+        :'cart_item_ids' => :'cart_item_ids',
+        :'email' => :'email',
+        :'esp_commseq_step_uuid' => :'esp_commseq_step_uuid',
+        :'esp_commseq_uuid' => :'esp_commseq_uuid',
+        :'name' => :'name',
+        :'order_id' => :'order_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cart_id' => :'String',
+        :'cart_item_ids' => :'Array<String>',
+        :'email' => :'String',
+        :'esp_commseq_step_uuid' => :'String',
+        :'esp_commseq_uuid' => :'String',
+        :'name' => :'String',
+        :'order_id' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'cart_id')
+        self.cart_id = attributes[:'cart_id']
+      end
+
+      if attributes.has_key?(:'cart_item_ids')
+        if (value = attributes[:'cart_item_ids']).is_a?(Array)
+          self.cart_item_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'esp_commseq_step_uuid')
+        self.esp_commseq_step_uuid = attributes[:'esp_commseq_step_uuid']
+      end
+
+      if attributes.has_key?(:'esp_commseq_uuid')
+        self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          cart_id == o.cart_id &&
+          cart_item_ids == o.cart_item_ids &&
+          email == o.email &&
+          esp_commseq_step_uuid == o.esp_commseq_step_uuid &&
+          esp_commseq_uuid == o.esp_commseq_uuid &&
+          name == o.name &&
+          order_id == o.order_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [cart_id, cart_item_ids, email, esp_commseq_step_uuid, esp_commseq_uuid, name, order_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.5.0'
+  VERSION = '3.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - UltraCart
@@ -429,6 +429,7 @@ files:
 - docs/EmailCommseqStep.md
 - docs/EmailCommseqStepLog.md
 - docs/EmailCommseqStepLogsResponse.md
+- docs/EmailCommseqWebhookSendTestRequest.md
 - docs/EmailCommseqsResponse.md
 - docs/EmailCustomer.md
 - docs/EmailCustomerEditorUrlResponse.md
@@ -1092,6 +1093,7 @@ files:
 - lib/ultracart_api/models/email_commseq_step.rb
 - lib/ultracart_api/models/email_commseq_step_log.rb
 - lib/ultracart_api/models/email_commseq_step_logs_response.rb
+- lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb
 - lib/ultracart_api/models/email_commseqs_response.rb
 - lib/ultracart_api/models/email_customer.rb
 - lib/ultracart_api/models/email_customer_editor_url_response.rb