docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/billing_invoice_item.rb

@@ -26,6 +26,12 @@ module DocuSign_eSign
     # 
     attr_accessor :quantity
 
+    # 
+    attr_accessor :tax_amount
+
+    # 
+    attr_accessor :tax_exempt_amount
+
     # Reserved: TBD
     attr_accessor :unit_price
 
@@ -36,6 +42,8 @@ module DocuSign_eSign
         :'charge_name' => :'chargeName',
         :'invoice_item_id' => :'invoiceItemId',
         :'quantity' => :'quantity',
+        :'tax_amount' => :'taxAmount',
+        :'tax_exempt_amount' => :'taxExemptAmount',
         :'unit_price' => :'unitPrice'
       }
     end
@@ -47,6 +55,8 @@ module DocuSign_eSign
         :'charge_name' => :'String',
         :'invoice_item_id' => :'String',
         :'quantity' => :'String',
+        :'tax_amount' => :'String',
+        :'tax_exempt_amount' => :'String',
         :'unit_price' => :'String'
       }
     end
@@ -75,6 +85,14 @@ module DocuSign_eSign
         self.quantity = attributes[:'quantity']
       end
 
+      if attributes.has_key?(:'taxAmount')
+        self.tax_amount = attributes[:'taxAmount']
+      end
+
+      if attributes.has_key?(:'taxExemptAmount')
+        self.tax_exempt_amount = attributes[:'taxExemptAmount']
+      end
+
       if attributes.has_key?(:'unitPrice')
         self.unit_price = attributes[:'unitPrice']
       end
@@ -102,6 +120,8 @@ module DocuSign_eSign
           charge_name == o.charge_name &&
           invoice_item_id == o.invoice_item_id &&
           quantity == o.quantity &&
+          tax_amount == o.tax_amount &&
+          tax_exempt_amount == o.tax_exempt_amount &&
           unit_price == o.unit_price
     end
 
@@ -114,7 +134,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [charge_amount, charge_name, invoice_item_id, quantity, unit_price].hash
+      [charge_amount, charge_name, invoice_item_id, quantity, tax_amount, tax_exempt_amount, unit_price].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/billing_invoices_summary.rb

@@ -13,9 +13,15 @@ require 'date'
 
 module DocuSign_eSign
   class BillingInvoicesSummary
+    # 
+    attr_accessor :account_balance
+
     # Reserved: TBD
     attr_accessor :billing_invoices
 
+    # 
+    attr_accessor :currency_code
+
     # 
     attr_accessor :past_due_balance
 
@@ -25,7 +31,9 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'account_balance' => :'accountBalance',
         :'billing_invoices' => :'billingInvoices',
+        :'currency_code' => :'currencyCode',
         :'past_due_balance' => :'pastDueBalance',
         :'payment_allowed' => :'paymentAllowed'
       }
@@ -34,7 +42,9 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'account_balance' => :'String',
         :'billing_invoices' => :'Array<BillingInvoice>',
+        :'currency_code' => :'String',
         :'past_due_balance' => :'String',
         :'payment_allowed' => :'String'
       }
@@ -48,12 +58,20 @@ module DocuSign_eSign
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'accountBalance')
+        self.account_balance = attributes[:'accountBalance']
+      end
+
       if attributes.has_key?(:'billingInvoices')
         if (value = attributes[:'billingInvoices']).is_a?(Array)
           self.billing_invoices = value
         end
       end
 
+      if attributes.has_key?(:'currencyCode')
+        self.currency_code = attributes[:'currencyCode']
+      end
+
       if attributes.has_key?(:'pastDueBalance')
         self.past_due_balance = attributes[:'pastDueBalance']
       end
@@ -81,7 +99,9 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          account_balance == o.account_balance &&
           billing_invoices == o.billing_invoices &&
+          currency_code == o.currency_code &&
           past_due_balance == o.past_due_balance &&
           payment_allowed == o.payment_allowed
     end
@@ -95,7 +115,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [billing_invoices, past_due_balance, payment_allowed].hash
+      [account_balance, billing_invoices, currency_code, past_due_balance, payment_allowed].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/billing_plan_information.rb

@@ -12,18 +12,26 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains details about a billing plan.
   class BillingPlanInformation
+    # 
     attr_accessor :app_store_receipt
 
+    # The billing address for the account.
     attr_accessor :billing_address
 
+    # A complex type that has information about the credit card used to pay for this account.
     attr_accessor :credit_card_information
 
+    # Information about the bank that processes direct debits for the payment plan.
     attr_accessor :direct_debit_processor_information
 
     # 
     attr_accessor :downgrade_reason
 
+    # 
+    attr_accessor :enable_pre_auth
+
     # 
     attr_accessor :enable_support
 
@@ -36,10 +44,19 @@ module DocuSign_eSign
     # 
     attr_accessor :payment_method
 
+    # 
+    attr_accessor :payment_processor
+
+    # Information about the entity that processes payments for the billing plan.
     attr_accessor :payment_processor_information
 
+    # An object used to identify the features and attributes of the account being created.
     attr_accessor :plan_information
 
+    # 
+    attr_accessor :process_payment
+
+    # A complex type that contains properties for entering referral and discount information.
     attr_accessor :referral_information
 
     # 
@@ -60,6 +77,9 @@ module DocuSign_eSign
     # 
     attr_accessor :sale_discount_seat_price_override
 
+    # 
+    attr_accessor :tax_exempt_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -68,19 +88,23 @@ module DocuSign_eSign
         :'credit_card_information' => :'creditCardInformation',
         :'direct_debit_processor_information' => :'directDebitProcessorInformation',
         :'downgrade_reason' => :'downgradeReason',
+        :'enable_pre_auth' => :'enablePreAuth',
         :'enable_support' => :'enableSupport',
         :'included_seats' => :'includedSeats',
         :'incremental_seats' => :'incrementalSeats',
         :'payment_method' => :'paymentMethod',
+        :'payment_processor' => :'paymentProcessor',
         :'payment_processor_information' => :'paymentProcessorInformation',
         :'plan_information' => :'planInformation',
+        :'process_payment' => :'processPayment',
         :'referral_information' => :'referralInformation',
         :'renewal_status' => :'renewalStatus',
         :'sale_discount_amount' => :'saleDiscountAmount',
         :'sale_discount_fixed_amount' => :'saleDiscountFixedAmount',
         :'sale_discount_percent' => :'saleDiscountPercent',
         :'sale_discount_periods' => :'saleDiscountPeriods',
-        :'sale_discount_seat_price_override' => :'saleDiscountSeatPriceOverride'
+        :'sale_discount_seat_price_override' => :'saleDiscountSeatPriceOverride',
+        :'tax_exempt_id' => :'taxExemptId'
       }
     end
 
@@ -92,19 +116,23 @@ module DocuSign_eSign
         :'credit_card_information' => :'CreditCardInformation',
         :'direct_debit_processor_information' => :'DirectDebitProcessorInformation',
         :'downgrade_reason' => :'String',
+        :'enable_pre_auth' => :'String',
         :'enable_support' => :'String',
         :'included_seats' => :'String',
         :'incremental_seats' => :'String',
         :'payment_method' => :'String',
+        :'payment_processor' => :'String',
         :'payment_processor_information' => :'PaymentProcessorInformation',
         :'plan_information' => :'PlanInformation',
+        :'process_payment' => :'String',
         :'referral_information' => :'ReferralInformation',
         :'renewal_status' => :'String',
         :'sale_discount_amount' => :'String',
         :'sale_discount_fixed_amount' => :'String',
         :'sale_discount_percent' => :'String',
         :'sale_discount_periods' => :'String',
-        :'sale_discount_seat_price_override' => :'String'
+        :'sale_discount_seat_price_override' => :'String',
+        :'tax_exempt_id' => :'String'
       }
     end
 
@@ -136,6 +164,10 @@ module DocuSign_eSign
         self.downgrade_reason = attributes[:'downgradeReason']
       end
 
+      if attributes.has_key?(:'enablePreAuth')
+        self.enable_pre_auth = attributes[:'enablePreAuth']
+      end
+
       if attributes.has_key?(:'enableSupport')
         self.enable_support = attributes[:'enableSupport']
       end
@@ -152,6 +184,10 @@ module DocuSign_eSign
         self.payment_method = attributes[:'paymentMethod']
       end
 
+      if attributes.has_key?(:'paymentProcessor')
+        self.payment_processor = attributes[:'paymentProcessor']
+      end
+
       if attributes.has_key?(:'paymentProcessorInformation')
         self.payment_processor_information = attributes[:'paymentProcessorInformation']
       end
@@ -160,6 +196,10 @@ module DocuSign_eSign
         self.plan_information = attributes[:'planInformation']
       end
 
+      if attributes.has_key?(:'processPayment')
+        self.process_payment = attributes[:'processPayment']
+      end
+
       if attributes.has_key?(:'referralInformation')
         self.referral_information = attributes[:'referralInformation']
       end
@@ -187,6 +227,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'saleDiscountSeatPriceOverride')
         self.sale_discount_seat_price_override = attributes[:'saleDiscountSeatPriceOverride']
       end
+
+      if attributes.has_key?(:'taxExemptId')
+        self.tax_exempt_id = attributes[:'taxExemptId']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -212,19 +256,23 @@ module DocuSign_eSign
           credit_card_information == o.credit_card_information &&
           direct_debit_processor_information == o.direct_debit_processor_information &&
           downgrade_reason == o.downgrade_reason &&
+          enable_pre_auth == o.enable_pre_auth &&
           enable_support == o.enable_support &&
           included_seats == o.included_seats &&
           incremental_seats == o.incremental_seats &&
           payment_method == o.payment_method &&
+          payment_processor == o.payment_processor &&
           payment_processor_information == o.payment_processor_information &&
           plan_information == o.plan_information &&
+          process_payment == o.process_payment &&
           referral_information == o.referral_information &&
           renewal_status == o.renewal_status &&
           sale_discount_amount == o.sale_discount_amount &&
           sale_discount_fixed_amount == o.sale_discount_fixed_amount &&
           sale_discount_percent == o.sale_discount_percent &&
           sale_discount_periods == o.sale_discount_periods &&
-          sale_discount_seat_price_override == o.sale_discount_seat_price_override
+          sale_discount_seat_price_override == o.sale_discount_seat_price_override &&
+          tax_exempt_id == o.tax_exempt_id
     end
 
     # @see the `==` method
@@ -236,7 +284,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_support, included_seats, incremental_seats, payment_method, payment_processor_information, plan_information, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override].hash
+      [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, tax_exempt_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/billing_plan_preview.rb

@@ -17,6 +17,7 @@ module DocuSign_eSign
     # Specifies the ISO currency code for the account.
     attr_accessor :currency_code
 
+    # 
     attr_accessor :invoice
 
     # 

data/lib/docusign_esign/models/billing_plan_response.rb

@@ -14,6 +14,7 @@ require 'date'
 module DocuSign_eSign
   # Defines a billing plan response object.
   class BillingPlanResponse
+    # An object that contains details about the billing plan.
     attr_accessor :billing_plan
 
     # 

data/lib/docusign_esign/models/billing_plan_update_response.rb

@@ -17,6 +17,7 @@ module DocuSign_eSign
     # 
     attr_accessor :account_payment_method
 
+    # 
     attr_accessor :billing_plan_preview
 
     # Specifies the ISO currency code for the account.

data/lib/docusign_esign/models/brand.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.
   class Brand
     # The name of the company associated with this brand.
     attr_accessor :brand_company
@@ -34,6 +35,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email_content
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
@@ -51,8 +53,10 @@ module DocuSign_eSign
     # 
     attr_accessor :links
 
+    # The URIs for retrieving the logos that are associated with the brand.
     attr_accessor :logos
 
+    # An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.  **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`.
     attr_accessor :resources
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/brand_email_content.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Deprecated.
   class BrandEmailContent
     # 
     attr_accessor :content

data/lib/docusign_esign/models/brand_link.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a link that a brand uses.
   class BrandLink
     # 
     attr_accessor :link_text

data/lib/docusign_esign/models/brand_logos.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The URIs for retrieving the logos that are associated with the brand.  These are read-only properties that provide a URI to logos in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). 
   class BrandLogos
     # 
     attr_accessor :email

data/lib/docusign_esign/models/brand_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This request object contains information about a specific brand.
   class BrandRequest
     # The ID of the brand used in API calls
     attr_accessor :brand_id

data/lib/docusign_esign/models/brand_resource_urls.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Brands use resource files to style the following experiences:   - Email - Sending - Signing - Captive (embedded) signing   You can modify these resource files to customize these experiences.
   class BrandResourceUrls
     # 
     attr_accessor :email

data/lib/docusign_esign/models/brand_resources.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.
   class BrandResources
+    # The user ID of the user who created the brand resource.
     attr_accessor :created_by_user_info
 
     # 
@@ -21,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :data_not_saved_not_in_master
 
+    # Information about the user who last modified the brand resource.
     attr_accessor :modified_by_user_info
 
     # 

data/lib/docusign_esign/models/brands_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about one or more brands.
   class BrandsRequest
     # The list of brands.
     attr_accessor :brands

data/lib/docusign_esign/models/bulk_envelope.rb

@@ -28,6 +28,7 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
     attr_accessor :envelope_uri
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/bulk_process_request.rb

@@ -0,0 +1,194 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class BulkProcessRequest
+    # 
+    attr_accessor :batch_name
+
+    # 
+    attr_accessor :envelope_or_template_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batch_name' => :'batchName',
+        :'envelope_or_template_id' => :'envelopeOrTemplateId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'batch_name' => :'String',
+        :'envelope_or_template_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?(:'batchName')
+        self.batch_name = attributes[:'batchName']
+      end
+
+      if attributes.has_key?(:'envelopeOrTemplateId')
+        self.envelope_or_template_id = attributes[:'envelopeOrTemplateId']
+      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 &&
+          batch_name == o.batch_name &&
+          envelope_or_template_id == o.envelope_or_template_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
+      [batch_name, envelope_or_template_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 = DocuSign_eSign.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