maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/models/create_invoice_payment_application.rb

@@ -64,5 +64,27 @@ module AdvancedBilling
                                           amount,
                                           hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoicePaymentApplication | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.invoice_uid,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['invoice_uid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
   end
 end

data/lib/advanced_billing/models/create_multi_invoice_payment.rb

@@ -126,7 +126,9 @@ module AdvancedBilling
           UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
                          .validate(value.amount) and
             APIHelper.valid_type?(value.applications,
-                                  ->(val) { CreateInvoicePaymentApplication.validate(val) })
+                                  ->(val) { CreateInvoicePaymentApplication.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
         )
       end
 
@@ -136,7 +138,9 @@ module AdvancedBilling
         UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
                        .validate(value['amount']) and
           APIHelper.valid_type?(value['applications'],
-                                ->(val) { CreateInvoicePaymentApplication.validate(val) })
+                                ->(val) { CreateInvoicePaymentApplication.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/create_offer_component.rb

@@ -13,6 +13,10 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :component_id
 
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
     # TODO: Write general description for this method
     # @return [Integer]
     attr_accessor :starting_quantity
@@ -21,6 +25,7 @@ module AdvancedBilling
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
       @_hash['starting_quantity'] = 'starting_quantity'
       @_hash
     end
@@ -29,6 +34,7 @@ module AdvancedBilling
     def self.optionals
       %w[
         component_id
+        price_point_id
         starting_quantity
       ]
     end
@@ -39,9 +45,11 @@ module AdvancedBilling
     end
 
     def initialize(component_id = SKIP,
+                   price_point_id = SKIP,
                    starting_quantity = SKIP,
                    additional_properties = {})
       @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
       @starting_quantity = starting_quantity unless starting_quantity == SKIP
 
       # Add additional model properties to the instance.
@@ -56,6 +64,8 @@ module AdvancedBilling
 
       # Extract variables from the hash.
       component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
       starting_quantity =
         hash.key?('starting_quantity') ? hash['starting_quantity'] : SKIP
 
@@ -64,6 +74,7 @@ module AdvancedBilling
 
       # Create object from extracted values.
       CreateOfferComponent.new(component_id,
+                               price_point_id,
                                starting_quantity,
                                hash)
     end

data/lib/advanced_billing/models/create_payment_profile.rb

@@ -155,13 +155,13 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :bank_routing_number
 
-    # (Required when creating with ACH, GoCardless, Stripe BECS Direct Debit and
-    # bank_iban is blank) The customerʼs bank account number
+    # (Required when creating with ACH, GoCardless, Stripe BECS or BACS Direct
+    # Debit, and bank_iban is blank) The customerʼs bank account number
     # @return [String]
     attr_accessor :bank_account_number
 
-    # (Optional when creating with GoCardless, required with Stripe BECS Direct
-    # Debit) Branch code. Alternatively, an IBAN can be provided
+    # (Optional when creating with GoCardless, required with Stripe BECS or BACS
+    # Direct Debit) Branch/Sort code. Alternatively, an IBAN can be provided
     # @return [String]
     attr_accessor :bank_branch_code
 

data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb

@@ -184,9 +184,12 @@ module AdvancedBilling
             APIHelper.valid_type?(value.pricing_scheme,
                                   ->(val) { PricingScheme.validate(val) }) and
             APIHelper.valid_type?(value.prices,
-                                  ->(val) { Price.validate(val) }) and
+                                  ->(val) { Price.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
             APIHelper.valid_type?(value.overage_pricing,
-                                  ->(val) { OveragePricing.validate(val) })
+                                  ->(val) { OveragePricing.validate(val) },
+                                  is_model_hash: true)
         )
       end
 
@@ -198,9 +201,12 @@ module AdvancedBilling
           APIHelper.valid_type?(value['pricing_scheme'],
                                 ->(val) { PricingScheme.validate(val) }) and
           APIHelper.valid_type?(value['prices'],
-                                ->(val) { Price.validate(val) }) and
+                                ->(val) { Price.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
           APIHelper.valid_type?(value['overage_pricing'],
-                                ->(val) { OveragePricing.validate(val) })
+                                ->(val) { OveragePricing.validate(val) },
+                                is_model_hash: true)
       )
     end
   end

data/lib/advanced_billing/models/create_product_family.rb

@@ -13,6 +13,10 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :name
 
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :description
@@ -21,6 +25,7 @@ module AdvancedBilling
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
       @_hash['description'] = 'description'
       @_hash
     end
@@ -28,7 +33,7 @@ module AdvancedBilling
     # An array for optional fields
     def self.optionals
       %w[
-        name
+        handle
         description
       ]
     end
@@ -36,14 +41,17 @@ module AdvancedBilling
     # An array for nullable fields
     def self.nullables
       %w[
+        handle
         description
       ]
     end
 
-    def initialize(name = SKIP,
+    def initialize(name = nil,
+                   handle = SKIP,
                    description = SKIP,
                    additional_properties = {})
-      @name = name unless name == SKIP
+      @name = name
+      @handle = handle unless handle == SKIP
       @description = description unless description == SKIP
 
       # Add additional model properties to the instance.
@@ -57,7 +65,8 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      name = hash.key?('name') ? hash['name'] : SKIP
+      name = hash.key?('name') ? hash['name'] : nil
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
 
       # Clean out expected properties from Hash.
@@ -65,6 +74,7 @@ module AdvancedBilling
 
       # Create object from extracted values.
       CreateProductFamily.new(name,
+                              handle,
                               description,
                               hash)
     end

data/lib/advanced_billing/models/create_subscription.rb

@@ -437,7 +437,7 @@ module AdvancedBilling
                    custom_price = SKIP,
                    coupon_code = SKIP,
                    coupon_codes = SKIP,
-                   payment_collection_method = CollectionMethod::AUTOMATIC,
+                   payment_collection_method = SKIP,
                    receives_invoice_emails = SKIP,
                    net_terms = SKIP,
                    customer_id = SKIP,
@@ -580,7 +580,7 @@ module AdvancedBilling
       coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
       coupon_codes = hash.key?('coupon_codes') ? hash['coupon_codes'] : SKIP
       payment_collection_method =
-        hash['payment_collection_method'] ||= CollectionMethod::AUTOMATIC
+        hash.key?('payment_collection_method') ? hash['payment_collection_method'] : SKIP
       receives_invoice_emails =
         hash.key?('receives_invoice_emails') ? hash['receives_invoice_emails'] : SKIP
       net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP

data/lib/advanced_billing/models/credit_card_attributes.rb

@@ -78,5 +78,15 @@ module AdvancedBilling
                                expiration_year,
                                hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditCardAttributes | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/credit_note_application.rb

@@ -106,5 +106,15 @@ module AdvancedBilling
     def to_custom_transaction_time
       DateTimeHelper.to_rfc3339(transaction_time)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteApplication | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/credit_note_line_item.rb

@@ -275,5 +275,15 @@ module AdvancedBilling
                              custom_item,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteLineItem | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/customer.rb

@@ -27,7 +27,9 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :cc_emails
 
-    # The organization of the customer
+    # The organization of the customer. If no value, `null` or empty string is
+    # provided, `organization` will be populated with the customer's first and
+    # last name, separated with a space.
     # @return [String]
     attr_accessor :organization
 
@@ -402,5 +404,15 @@ module AdvancedBilling
     def to_custom_portal_invite_last_accepted_at
       DateTimeHelper.to_rfc3339(portal_invite_last_accepted_at)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [Customer | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/customer_attributes.rb

@@ -249,5 +249,15 @@ module AdvancedBilling
                              parent_id,
                              hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerAttributes | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/customer_change.rb

@@ -76,18 +76,13 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      payer = hash.key?('payer') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CustomerChangePayer), hash['payer']
-      ) : SKIP
-      shipping_address = hash.key?('shipping_address') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CustomerChangeShippingAddress), hash['shipping_address']
-      ) : SKIP
-      billing_address = hash.key?('billing_address') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CustomerChangeBillingAddress), hash['billing_address']
-      ) : SKIP
-      custom_fields = hash.key?('custom_fields') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CustomerChangeCustomFields), hash['custom_fields']
-      ) : SKIP
+      payer = CustomerPayerChange.from_hash(hash['payer']) if hash['payer']
+      shipping_address = AddressChange.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      billing_address = AddressChange.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      custom_fields = CustomerCustomFieldsChange.from_hash(hash['custom_fields']) if
+        hash['custom_fields']
 
       # Clean out expected properties from Hash.
       names.each_value { |k| hash.delete(k) }
@@ -99,15 +94,5 @@ module AdvancedBilling
                          custom_fields,
                          hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [CustomerChange | Hash] The value against the validation is performed.
-    def self.validate(value)
-      return true if value.instance_of? self
-
-      return false unless value.instance_of? Hash
-
-      true
-    end
   end
 end

data/lib/advanced_billing/models/customer_custom_fields_change.rb

@@ -81,27 +81,5 @@ module AdvancedBilling
                                      after,
                                      hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [CustomerCustomFieldsChange | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.before,
-                                ->(val) { InvoiceCustomField.validate(val) }) and
-            APIHelper.valid_type?(value.after,
-                                  ->(val) { InvoiceCustomField.validate(val) })
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['before'],
-                              ->(val) { InvoiceCustomField.validate(val) }) and
-          APIHelper.valid_type?(value['after'],
-                                ->(val) { InvoiceCustomField.validate(val) })
-      )
-    end
   end
 end

data/lib/advanced_billing/models/customer_payer_change.rb

@@ -63,27 +63,5 @@ module AdvancedBilling
                               after,
                               hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [CustomerPayerChange | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.before,
-                                ->(val) { InvoicePayerChange.validate(val) }) and
-            APIHelper.valid_type?(value.after,
-                                  ->(val) { InvoicePayerChange.validate(val) })
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['before'],
-                              ->(val) { InvoicePayerChange.validate(val) }) and
-          APIHelper.valid_type?(value['after'],
-                                ->(val) { InvoicePayerChange.validate(val) })
-      )
-    end
   end
 end