ultracart_api 4.1.230 → 4.1.232

data/lib/ultracart_api/models/sfvb_transactional_sender.rb

@@ -0,0 +1,250 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbTransactionalSender
+    # The sending domain uuid, or none.
+    attr_accessor :sending_domain_uuid
+
+    # The from name.
+    attr_accessor :sending_name
+
+    # The part of the from address before the at sign.
+    attr_accessor :sending_user
+
+    # True when it sends through the merchant's own mail server, which only the admin changes.  Its credentials are never returned.
+    attr_accessor :smtp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sending_domain_uuid' => :'sending_domain_uuid',
+        :'sending_name' => :'sending_name',
+        :'sending_user' => :'sending_user',
+        :'smtp' => :'smtp'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'sending_domain_uuid' => :'String',
+        :'sending_name' => :'String',
+        :'sending_user' => :'String',
+        :'smtp' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbTransactionalSender` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbTransactionalSender`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'sending_domain_uuid')
+        self.sending_domain_uuid = attributes[:'sending_domain_uuid']
+      end
+
+      if attributes.key?(:'sending_name')
+        self.sending_name = attributes[:'sending_name']
+      end
+
+      if attributes.key?(:'sending_user')
+        self.sending_user = attributes[:'sending_user']
+      end
+
+      if attributes.key?(:'smtp')
+        self.smtp = attributes[:'smtp']
+      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 &&
+          sending_domain_uuid == o.sending_domain_uuid &&
+          sending_name == o.sending_name &&
+          sending_user == o.sending_user &&
+          smtp == o.smtp
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [sending_domain_uuid, sending_name, sending_user, smtp].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.230'
+  VERSION = '4.1.232'
 end

data/lib/ultracart_api.rb

@@ -1006,6 +1006,13 @@ require 'ultracart_api/models/sfvb_campaign_write_request'
 require 'ultracart_api/models/sfvb_campaigns_response'
 require 'ultracart_api/models/sfvb_code_library_email'
 require 'ultracart_api/models/sfvb_code_library_emails_response'
+require 'ultracart_api/models/sfvb_comms_branch_stat'
+require 'ultracart_api/models/sfvb_comms_change'
+require 'ultracart_api/models/sfvb_comms_click'
+require 'ultracart_api/models/sfvb_comms_clicks_response'
+require 'ultracart_api/models/sfvb_comms_daily_stat'
+require 'ultracart_api/models/sfvb_comms_dashboard_response'
+require 'ultracart_api/models/sfvb_comms_dashboard_row'
 require 'ultracart_api/models/sfvb_comms_dns_record'
 require 'ultracart_api/models/sfvb_comms_email'
 require 'ultracart_api/models/sfvb_comms_folder'
@@ -1018,15 +1025,39 @@ require 'ultracart_api/models/sfvb_comms_list_detail'
 require 'ultracart_api/models/sfvb_comms_list_response'
 require 'ultracart_api/models/sfvb_comms_list_write_request'
 require 'ultracart_api/models/sfvb_comms_lists_response'
+require 'ultracart_api/models/sfvb_comms_member'
+require 'ultracart_api/models/sfvb_comms_members_response'
+require 'ultracart_api/models/sfvb_comms_plan'
+require 'ultracart_api/models/sfvb_comms_plan_response'
 require 'ultracart_api/models/sfvb_comms_postcard'
+require 'ultracart_api/models/sfvb_comms_provider'
+require 'ultracart_api/models/sfvb_comms_provider_import_request'
+require 'ultracart_api/models/sfvb_comms_provider_import_response'
+require 'ultracart_api/models/sfvb_comms_provider_list'
+require 'ultracart_api/models/sfvb_comms_providers_response'
 require 'ultracart_api/models/sfvb_comms_segment'
 require 'ultracart_api/models/sfvb_comms_segment_detail'
 require 'ultracart_api/models/sfvb_comms_segment_response'
 require 'ultracart_api/models/sfvb_comms_segment_used_by'
 require 'ultracart_api/models/sfvb_comms_segment_write_request'
 require 'ultracart_api/models/sfvb_comms_segments_response'
+require 'ultracart_api/models/sfvb_comms_sender'
+require 'ultracart_api/models/sfvb_comms_sender_update'
 require 'ultracart_api/models/sfvb_comms_sending_domain'
 require 'ultracart_api/models/sfvb_comms_sending_domains_response'
+require 'ultracart_api/models/sfvb_comms_sequence_stats_response'
+require 'ultracart_api/models/sfvb_comms_settings'
+require 'ultracart_api/models/sfvb_comms_settings_response'
+require 'ultracart_api/models/sfvb_comms_settings_update_request'
+require 'ultracart_api/models/sfvb_comms_stat'
+require 'ultracart_api/models/sfvb_comms_step_stat'
+require 'ultracart_api/models/sfvb_comms_template'
+require 'ultracart_api/models/sfvb_comms_template_response'
+require 'ultracart_api/models/sfvb_comms_templates_response'
+require 'ultracart_api/models/sfvb_comms_test_email_request'
+require 'ultracart_api/models/sfvb_comms_test_postcard_request'
+require 'ultracart_api/models/sfvb_comms_test_send_response'
+require 'ultracart_api/models/sfvb_comms_test_sms_request'
 require 'ultracart_api/models/sfvb_comms_twilio_account'
 require 'ultracart_api/models/sfvb_comms_twilio_account_response'
 require 'ultracart_api/models/sfvb_compile_request'
@@ -1166,8 +1197,11 @@ require 'ultracart_api/models/sfvb_page_response'
 require 'ultracart_api/models/sfvb_page_selectors'
 require 'ultracart_api/models/sfvb_page_settings_request'
 require 'ultracart_api/models/sfvb_page_summary'
+require 'ultracart_api/models/sfvb_postcard_address'
+require 'ultracart_api/models/sfvb_postcard_card'
 require 'ultracart_api/models/sfvb_postcard_proof_request'
 require 'ultracart_api/models/sfvb_postcard_proof_response'
+require 'ultracart_api/models/sfvb_postcard_tracking_response'
 require 'ultracart_api/models/sfvb_preview_access_request'
 require 'ultracart_api/models/sfvb_preview_access_response'
 require 'ultracart_api/models/sfvb_preview_session_request'
@@ -1276,8 +1310,14 @@ require 'ultracart_api/models/sfvb_tracking_provider_secrets'
 require 'ultracart_api/models/sfvb_tracking_providers_response'
 require 'ultracart_api/models/sfvb_tracking_settings_response'
 require 'ultracart_api/models/sfvb_tracking_wholesale_tier'
+require 'ultracart_api/models/sfvb_transactional_change'
+require 'ultracart_api/models/sfvb_transactional_delivery_option'
 require 'ultracart_api/models/sfvb_transactional_email'
+require 'ultracart_api/models/sfvb_transactional_email_detail'
+require 'ultracart_api/models/sfvb_transactional_email_response'
+require 'ultracart_api/models/sfvb_transactional_email_update_request'
 require 'ultracart_api/models/sfvb_transactional_emails_response'
+require 'ultracart_api/models/sfvb_transactional_sender'
 require 'ultracart_api/models/sfvb_upsell_item_logic'
 require 'ultracart_api/models/sfvb_upsell_item_logic_item'
 require 'ultracart_api/models/sfvb_upsell_offer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.230
+  version: 4.1.232
 platform: ruby
 authors:
 - UltraCart
@@ -1068,6 +1068,13 @@ files:
 - docs/SfvbCampaignsResponse.md
 - docs/SfvbCodeLibraryEmail.md
 - docs/SfvbCodeLibraryEmailsResponse.md
+- docs/SfvbCommsBranchStat.md
+- docs/SfvbCommsChange.md
+- docs/SfvbCommsClick.md
+- docs/SfvbCommsClicksResponse.md
+- docs/SfvbCommsDailyStat.md
+- docs/SfvbCommsDashboardResponse.md
+- docs/SfvbCommsDashboardRow.md
 - docs/SfvbCommsDnsRecord.md
 - docs/SfvbCommsEmail.md
 - docs/SfvbCommsFolder.md
@@ -1080,15 +1087,39 @@ files:
 - docs/SfvbCommsListResponse.md
 - docs/SfvbCommsListWriteRequest.md
 - docs/SfvbCommsListsResponse.md
+- docs/SfvbCommsMember.md
+- docs/SfvbCommsMembersResponse.md
+- docs/SfvbCommsPlan.md
+- docs/SfvbCommsPlanResponse.md
 - docs/SfvbCommsPostcard.md
+- docs/SfvbCommsProvider.md
+- docs/SfvbCommsProviderImportRequest.md
+- docs/SfvbCommsProviderImportResponse.md
+- docs/SfvbCommsProviderList.md
+- docs/SfvbCommsProvidersResponse.md
 - docs/SfvbCommsSegment.md
 - docs/SfvbCommsSegmentDetail.md
 - docs/SfvbCommsSegmentResponse.md
 - docs/SfvbCommsSegmentUsedBy.md
 - docs/SfvbCommsSegmentWriteRequest.md
 - docs/SfvbCommsSegmentsResponse.md
+- docs/SfvbCommsSender.md
+- docs/SfvbCommsSenderUpdate.md
 - docs/SfvbCommsSendingDomain.md
 - docs/SfvbCommsSendingDomainsResponse.md
+- docs/SfvbCommsSequenceStatsResponse.md
+- docs/SfvbCommsSettings.md
+- docs/SfvbCommsSettingsResponse.md
+- docs/SfvbCommsSettingsUpdateRequest.md
+- docs/SfvbCommsStat.md
+- docs/SfvbCommsStepStat.md
+- docs/SfvbCommsTemplate.md
+- docs/SfvbCommsTemplateResponse.md
+- docs/SfvbCommsTemplatesResponse.md
+- docs/SfvbCommsTestEmailRequest.md
+- docs/SfvbCommsTestPostcardRequest.md
+- docs/SfvbCommsTestSendResponse.md
+- docs/SfvbCommsTestSmsRequest.md
 - docs/SfvbCommsTwilioAccount.md
 - docs/SfvbCommsTwilioAccountResponse.md
 - docs/SfvbCompileRequest.md
@@ -1228,8 +1259,11 @@ files:
 - docs/SfvbPageSelectors.md
 - docs/SfvbPageSettingsRequest.md
 - docs/SfvbPageSummary.md
+- docs/SfvbPostcardAddress.md
+- docs/SfvbPostcardCard.md
 - docs/SfvbPostcardProofRequest.md
 - docs/SfvbPostcardProofResponse.md
+- docs/SfvbPostcardTrackingResponse.md
 - docs/SfvbPreviewAccessRequest.md
 - docs/SfvbPreviewAccessResponse.md
 - docs/SfvbPreviewSessionRequest.md
@@ -1338,8 +1372,14 @@ files:
 - docs/SfvbTrackingProvidersResponse.md
 - docs/SfvbTrackingSettingsResponse.md
 - docs/SfvbTrackingWholesaleTier.md
+- docs/SfvbTransactionalChange.md
+- docs/SfvbTransactionalDeliveryOption.md
 - docs/SfvbTransactionalEmail.md
+- docs/SfvbTransactionalEmailDetail.md
+- docs/SfvbTransactionalEmailResponse.md
+- docs/SfvbTransactionalEmailUpdateRequest.md
 - docs/SfvbTransactionalEmailsResponse.md
+- docs/SfvbTransactionalSender.md
 - docs/SfvbUpsellItemLogic.md
 - docs/SfvbUpsellItemLogicItem.md
 - docs/SfvbUpsellOffer.md
@@ -2478,6 +2518,13 @@ files:
 - lib/ultracart_api/models/sfvb_campaigns_response.rb
 - lib/ultracart_api/models/sfvb_code_library_email.rb
 - lib/ultracart_api/models/sfvb_code_library_emails_response.rb
+- lib/ultracart_api/models/sfvb_comms_branch_stat.rb
+- lib/ultracart_api/models/sfvb_comms_change.rb
+- lib/ultracart_api/models/sfvb_comms_click.rb
+- lib/ultracart_api/models/sfvb_comms_clicks_response.rb
+- lib/ultracart_api/models/sfvb_comms_daily_stat.rb
+- lib/ultracart_api/models/sfvb_comms_dashboard_response.rb
+- lib/ultracart_api/models/sfvb_comms_dashboard_row.rb
 - lib/ultracart_api/models/sfvb_comms_dns_record.rb
 - lib/ultracart_api/models/sfvb_comms_email.rb
 - lib/ultracart_api/models/sfvb_comms_folder.rb
@@ -2490,15 +2537,39 @@ files:
 - lib/ultracart_api/models/sfvb_comms_list_response.rb
 - lib/ultracart_api/models/sfvb_comms_list_write_request.rb
 - lib/ultracart_api/models/sfvb_comms_lists_response.rb
+- lib/ultracart_api/models/sfvb_comms_member.rb
+- lib/ultracart_api/models/sfvb_comms_members_response.rb
+- lib/ultracart_api/models/sfvb_comms_plan.rb
+- lib/ultracart_api/models/sfvb_comms_plan_response.rb
 - lib/ultracart_api/models/sfvb_comms_postcard.rb
+- lib/ultracart_api/models/sfvb_comms_provider.rb
+- lib/ultracart_api/models/sfvb_comms_provider_import_request.rb
+- lib/ultracart_api/models/sfvb_comms_provider_import_response.rb
+- lib/ultracart_api/models/sfvb_comms_provider_list.rb
+- lib/ultracart_api/models/sfvb_comms_providers_response.rb
 - lib/ultracart_api/models/sfvb_comms_segment.rb
 - lib/ultracart_api/models/sfvb_comms_segment_detail.rb
 - lib/ultracart_api/models/sfvb_comms_segment_response.rb
 - lib/ultracart_api/models/sfvb_comms_segment_used_by.rb
 - lib/ultracart_api/models/sfvb_comms_segment_write_request.rb
 - lib/ultracart_api/models/sfvb_comms_segments_response.rb
+- lib/ultracart_api/models/sfvb_comms_sender.rb
+- lib/ultracart_api/models/sfvb_comms_sender_update.rb
 - lib/ultracart_api/models/sfvb_comms_sending_domain.rb
 - lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb
+- lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb
+- lib/ultracart_api/models/sfvb_comms_settings.rb
+- lib/ultracart_api/models/sfvb_comms_settings_response.rb
+- lib/ultracart_api/models/sfvb_comms_settings_update_request.rb
+- lib/ultracart_api/models/sfvb_comms_stat.rb
+- lib/ultracart_api/models/sfvb_comms_step_stat.rb
+- lib/ultracart_api/models/sfvb_comms_template.rb
+- lib/ultracart_api/models/sfvb_comms_template_response.rb
+- lib/ultracart_api/models/sfvb_comms_templates_response.rb
+- lib/ultracart_api/models/sfvb_comms_test_email_request.rb
+- lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb
+- lib/ultracart_api/models/sfvb_comms_test_send_response.rb
+- lib/ultracart_api/models/sfvb_comms_test_sms_request.rb
 - lib/ultracart_api/models/sfvb_comms_twilio_account.rb
 - lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb
 - lib/ultracart_api/models/sfvb_compile_request.rb
@@ -2638,8 +2709,11 @@ files:
 - lib/ultracart_api/models/sfvb_page_selectors.rb
 - lib/ultracart_api/models/sfvb_page_settings_request.rb
 - lib/ultracart_api/models/sfvb_page_summary.rb
+- lib/ultracart_api/models/sfvb_postcard_address.rb
+- lib/ultracart_api/models/sfvb_postcard_card.rb
 - lib/ultracart_api/models/sfvb_postcard_proof_request.rb
 - lib/ultracart_api/models/sfvb_postcard_proof_response.rb
+- lib/ultracart_api/models/sfvb_postcard_tracking_response.rb
 - lib/ultracart_api/models/sfvb_preview_access_request.rb
 - lib/ultracart_api/models/sfvb_preview_access_response.rb
 - lib/ultracart_api/models/sfvb_preview_session_request.rb
@@ -2748,8 +2822,14 @@ files:
 - lib/ultracart_api/models/sfvb_tracking_providers_response.rb
 - lib/ultracart_api/models/sfvb_tracking_settings_response.rb
 - lib/ultracart_api/models/sfvb_tracking_wholesale_tier.rb
+- lib/ultracart_api/models/sfvb_transactional_change.rb
+- lib/ultracart_api/models/sfvb_transactional_delivery_option.rb
 - lib/ultracart_api/models/sfvb_transactional_email.rb
+- lib/ultracart_api/models/sfvb_transactional_email_detail.rb
+- lib/ultracart_api/models/sfvb_transactional_email_response.rb
+- lib/ultracart_api/models/sfvb_transactional_email_update_request.rb
 - lib/ultracart_api/models/sfvb_transactional_emails_response.rb
+- lib/ultracart_api/models/sfvb_transactional_sender.rb
 - lib/ultracart_api/models/sfvb_upsell_item_logic.rb
 - lib/ultracart_api/models/sfvb_upsell_item_logic_item.rb
 - lib/ultracart_api/models/sfvb_upsell_offer.rb