maytes-api-client-rb 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b1e45e8514262fe4419ede71361f35f2d320a4b68d3a217914c54fa2b06b12
-  data.tar.gz: e1941d493e9ca0ec36c5383ddd7bcb7518c1769b2580e7726ad20a01827b1b98
+  metadata.gz: 1a9514629d2a505c5a9495b6603e2e2b260d618ec1fadd5b96a81d5cb40c9369
+  data.tar.gz: 5fb939659ca9d73e437d207d844899bd8f338807af89c57953088ce486a39448
 SHA512:
-  metadata.gz: e23bab9048ecb4b8eea187bcfffbe3b512210d5b21df517a3ae82d36654d0001ca892c5ee331ab2a8592c57acd41a5e9e5458b5fd9150c605105280f6d4fe338
-  data.tar.gz: 3b1cdaa8c86b6c9c86953371b5175a735db58c63784a5b12c22b26b865e0c3bad5ef2dda4de3dc5be11e01ce103324026e595c8aea8ec3ecc05339e144fbaea9
+  metadata.gz: c1f559ca0b54dd5f8bca9b486881239d3abb56e8a9a6dbc1137b08e0074cc065ce837124ef8e487c6e9482dbb7863d147a5135c4ca0f6e7c99fe4819e876c74b
+  data.tar.gz: 5421374a8653c2679ada8f0522a0d7e051e4b9d8cbc9da0cc796d76bffd67f0b48713bfc8fe4ddf682b8ae186be421715d2d9ebb18d67eca714acd4814b98d2f

data/docs/Checkout.md

@@ -17,6 +17,7 @@
 | **currency** | **String** |  |  |
 | **service_fee** | [**Fee**](Fee.md) |  |  |
 | **refunded_amount** | **Integer** |  |  |
+| **remaining_amount** | **Integer** |  |  |
 | **merchant_processor_fee** | **Integer** |  |  |
 | **merchant_service_fee** | **Integer** |  |  |
 | **last_refund_at** | **Time** |  |  |
@@ -40,6 +41,7 @@ instance = MaytesApiClient::Checkout.new(
   currency: null,
   service_fee: null,
   refunded_amount: null,
+  remaining_amount: null,
   merchant_processor_fee: null,
   merchant_service_fee: null,
   last_refund_at: null

data/docs/CheckoutFriend.md

@@ -0,0 +1,26 @@
+# MaytesApiClient::CheckoutFriend
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **mobile** | **String** | E.164, e.g. +61412345678 |  |
+| **email** | **String** |  | [optional] |
+| **amount** | **Integer** | This friend’s share in minor units. Give it for every friend or for none. | [optional] |
+| **items** | [**Array<CheckoutFriendItem>**](CheckoutFriendItem.md) | The cart lines this friend pays for (item_assignment only). Give it for every friend or for none. | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutFriend.new(
+  name: null,
+  mobile: null,
+  email: null,
+  amount: null,
+  items: null
+)
+```
+

data/docs/CheckoutFriendItem.md

@@ -0,0 +1,20 @@
+# MaytesApiClient::CheckoutFriendItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item_ref** | **String** |  |  |
+| **quantity** | **Integer** | How many units of this line this friend pays for. Omit for the whole line. | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutFriendItem.new(
+  item_ref: null,
+  quantity: null
+)
+```
+

data/docs/CheckoutFriends.md

@@ -0,0 +1,20 @@
+# MaytesApiClient::CheckoutFriends
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | How many friends will split, not counting the customer. Give this or `people`. | [optional] |
+| **people** | [**Array<CheckoutFriend>**](CheckoutFriend.md) | The friends, optionally with their shares. Give this or `count`. | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutFriends.new(
+  count: null,
+  people: null
+)
+```
+

data/docs/CreateCheckoutRequest.md

@@ -18,6 +18,7 @@
 | **customer_data** | [**CustomerData**](CustomerData.md) |  | [optional] |
 | **metadata** | **Hash<String, Object>** |  | [optional] |
 | **allocation_model** | **String** |  | [optional] |
+| **friends** | [**CheckoutFriends**](CheckoutFriends.md) | Who the customer is expected to split with. Pre-fills their share and allocation screens; the customer can still change it. Personal data — send it only when you hold it. | [optional] |
 
 ## Example
 
@@ -38,7 +39,8 @@ instance = MaytesApiClient::CreateCheckoutRequest.new(
   shipping_amount: null,
   customer_data: null,
   metadata: null,
-  allocation_model: null
+  allocation_model: null,
+  friends: null
 )
 ```
 

data/lib/maytes_api_client/models/checkout.rb

@@ -41,6 +41,8 @@ module MaytesApiClient
 
     attr_accessor :refunded_amount
 
+    attr_accessor :remaining_amount
+
     attr_accessor :merchant_processor_fee
 
     attr_accessor :merchant_service_fee
@@ -63,6 +65,7 @@ module MaytesApiClient
         :'currency' => :'currency',
         :'service_fee' => :'service_fee',
         :'refunded_amount' => :'refunded_amount',
+        :'remaining_amount' => :'remaining_amount',
         :'merchant_processor_fee' => :'merchant_processor_fee',
         :'merchant_service_fee' => :'merchant_service_fee',
         :'last_refund_at' => :'last_refund_at'
@@ -95,6 +98,7 @@ module MaytesApiClient
         :'currency' => :'String',
         :'service_fee' => :'Fee',
         :'refunded_amount' => :'Integer',
+        :'remaining_amount' => :'Integer',
         :'merchant_processor_fee' => :'Integer',
         :'merchant_service_fee' => :'Integer',
         :'last_refund_at' => :'Time'
@@ -208,6 +212,12 @@ module MaytesApiClient
         self.refunded_amount = nil
       end
 
+      if attributes.key?(:'remaining_amount')
+        self.remaining_amount = attributes[:'remaining_amount']
+      else
+        self.remaining_amount = nil
+      end
+
       if attributes.key?(:'merchant_processor_fee')
         self.merchant_processor_fee = attributes[:'merchant_processor_fee']
       else
@@ -264,6 +274,14 @@ module MaytesApiClient
         invalid_properties.push('invalid value for "refunded_amount", must be greater than or equal to 0.')
       end
 
+      if @remaining_amount.nil?
+        invalid_properties.push('invalid value for "remaining_amount", remaining_amount cannot be nil.')
+      end
+
+      if @remaining_amount < 0
+        invalid_properties.push('invalid value for "remaining_amount", must be greater than or equal to 0.')
+      end
+
       if @merchant_processor_fee.nil?
         invalid_properties.push('invalid value for "merchant_processor_fee", merchant_processor_fee cannot be nil.')
       end
@@ -295,6 +313,8 @@ module MaytesApiClient
       return false if @service_fee.nil?
       return false if @refunded_amount.nil?
       return false if @refunded_amount < 0
+      return false if @remaining_amount.nil?
+      return false if @remaining_amount < 0
       return false if @merchant_processor_fee.nil?
       return false if @merchant_processor_fee < 0
       return false if @merchant_service_fee.nil?
@@ -376,6 +396,20 @@ module MaytesApiClient
       @refunded_amount = refunded_amount
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] remaining_amount Value to be assigned
+    def remaining_amount=(remaining_amount)
+      if remaining_amount.nil?
+        fail ArgumentError, 'remaining_amount cannot be nil'
+      end
+
+      if remaining_amount < 0
+        fail ArgumentError, 'invalid value for "remaining_amount", must be greater than or equal to 0.'
+      end
+
+      @remaining_amount = remaining_amount
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] merchant_processor_fee Value to be assigned
     def merchant_processor_fee=(merchant_processor_fee)
@@ -422,6 +456,7 @@ module MaytesApiClient
           currency == o.currency &&
           service_fee == o.service_fee &&
           refunded_amount == o.refunded_amount &&
+          remaining_amount == o.remaining_amount &&
           merchant_processor_fee == o.merchant_processor_fee &&
           merchant_service_fee == o.merchant_service_fee &&
           last_refund_at == o.last_refund_at
@@ -436,7 +471,7 @@ module MaytesApiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [checkout_uuid, merchant_order_id, status, transaction_ref, checkout_url, merchant_expires_at, captured_at, return_url, cancel_url, amount, currency, service_fee, refunded_amount, merchant_processor_fee, merchant_service_fee, last_refund_at].hash
+      [checkout_uuid, merchant_order_id, status, transaction_ref, checkout_url, merchant_expires_at, captured_at, return_url, cancel_url, amount, currency, service_fee, refunded_amount, remaining_amount, merchant_processor_fee, merchant_service_fee, last_refund_at].hash
     end
 
     # Builds the object from hash

data/lib/maytes_api_client/models/checkout_friend.rb

@@ -0,0 +1,314 @@
+=begin
+#Maytes API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MaytesApiClient
+  class CheckoutFriend < ApiModelBase
+    attr_accessor :name
+
+    # E.164, e.g. +61412345678
+    attr_accessor :mobile
+
+    attr_accessor :email
+
+    # This friend’s share in minor units. Give it for every friend or for none.
+    attr_accessor :amount
+
+    # The cart lines this friend pays for (item_assignment only). Give it for every friend or for none.
+    attr_accessor :items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'mobile' => :'mobile',
+        :'email' => :'email',
+        :'amount' => :'amount',
+        :'items' => :'items'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'mobile' => :'String',
+        :'email' => :'String',
+        :'amount' => :'Integer',
+        :'items' => :'Array<CheckoutFriendItem>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'email',
+      ])
+    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 `MaytesApiClient::CheckoutFriend` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MaytesApiClient::CheckoutFriend`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'mobile')
+        self.mobile = attributes[:'mobile']
+      else
+        self.mobile = nil
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if @mobile.nil?
+        invalid_properties.push('invalid value for "mobile", mobile cannot be nil.')
+      end
+
+      if @mobile.to_s.length > 20
+        invalid_properties.push('invalid value for "mobile", the character length must be smaller than or equal to 20.')
+      end
+
+      if @mobile.to_s.length < 3
+        invalid_properties.push('invalid value for "mobile", the character length must be greater than or equal to 3.')
+      end
+
+      pattern = Regexp.new(/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/)
+      if !@email.nil? && @email !~ pattern
+        invalid_properties.push("invalid value for \"email\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@amount.nil? && @amount <= 0
+        invalid_properties.push('invalid value for "amount", must be greater than 0.')
+      end
+
+      if !@items.nil? && @items.length < 1
+        invalid_properties.push('invalid value for "items", number of items must be greater than or equal to 1.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @name.to_s.length > 200
+      return false if @name.to_s.length < 1
+      return false if @mobile.nil?
+      return false if @mobile.to_s.length > 20
+      return false if @mobile.to_s.length < 3
+      return false if !@email.nil? && @email !~ Regexp.new(/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/)
+      return false if !@amount.nil? && @amount <= 0
+      return false if !@items.nil? && @items.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mobile Value to be assigned
+    def mobile=(mobile)
+      if mobile.nil?
+        fail ArgumentError, 'mobile cannot be nil'
+      end
+
+      if mobile.to_s.length > 20
+        fail ArgumentError, 'invalid value for "mobile", the character length must be smaller than or equal to 20.'
+      end
+
+      if mobile.to_s.length < 3
+        fail ArgumentError, 'invalid value for "mobile", the character length must be greater than or equal to 3.'
+      end
+
+      @mobile = mobile
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      pattern = Regexp.new(/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/)
+      if !email.nil? && email !~ pattern
+        fail ArgumentError, "invalid value for \"email\", must conform to the pattern #{pattern}."
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      if amount <= 0
+        fail ArgumentError, 'invalid value for "amount", must be greater than 0.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] items Value to be assigned
+    def items=(items)
+      if items.nil?
+        fail ArgumentError, 'items cannot be nil'
+      end
+
+      if items.length < 1
+        fail ArgumentError, 'invalid value for "items", number of items must be greater than or equal to 1.'
+      end
+
+      @items = items
+    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 &&
+          name == o.name &&
+          mobile == o.mobile &&
+          email == o.email &&
+          amount == o.amount &&
+          items == o.items
+    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
+      [name, mobile, email, amount, items].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end