mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/client_purchase_record.rb

@@ -0,0 +1,142 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A record of a specific client purchase
+  class ClientPurchaseRecord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains the Sale details.
+    # @return [Sale]
+    attr_accessor :sale
+
+    # The item name and description.
+    # @return [String]
+    attr_accessor :description
+
+    # If `true`, the item was a payment credited to an account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :account_payment
+
+    # The price paid for the item.
+    # @return [Float]
+    attr_accessor :price
+
+    # The amount paid for the item.
+    # @return [Float]
+    attr_accessor :amount_paid
+
+    # The discount amount that was applied to the item.
+    # @return [Float]
+    attr_accessor :discount
+
+    # The amount of tax that was applied to the item.
+    # @return [Float]
+    attr_accessor :tax
+
+    # The return status of the item. If `true`, this item was returned.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :returned
+
+    # The quantity of the item purchased.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sale'] = 'Sale'
+      @_hash['description'] = 'Description'
+      @_hash['account_payment'] = 'AccountPayment'
+      @_hash['price'] = 'Price'
+      @_hash['amount_paid'] = 'AmountPaid'
+      @_hash['discount'] = 'Discount'
+      @_hash['tax'] = 'Tax'
+      @_hash['returned'] = 'Returned'
+      @_hash['quantity'] = 'Quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sale
+        description
+        account_payment
+        price
+        amount_paid
+        discount
+        tax
+        returned
+        quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sale = SKIP, description = SKIP, account_payment = SKIP,
+                   price = SKIP, amount_paid = SKIP, discount = SKIP,
+                   tax = SKIP, returned = SKIP, quantity = SKIP)
+      @sale = sale unless sale == SKIP
+      @description = description unless description == SKIP
+      @account_payment = account_payment unless account_payment == SKIP
+      @price = price unless price == SKIP
+      @amount_paid = amount_paid unless amount_paid == SKIP
+      @discount = discount unless discount == SKIP
+      @tax = tax unless tax == SKIP
+      @returned = returned unless returned == SKIP
+      @quantity = quantity unless quantity == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sale = Sale.from_hash(hash['Sale']) if hash['Sale']
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      account_payment =
+        hash.key?('AccountPayment') ? hash['AccountPayment'] : SKIP
+      price = hash.key?('Price') ? hash['Price'] : SKIP
+      amount_paid = hash.key?('AmountPaid') ? hash['AmountPaid'] : SKIP
+      discount = hash.key?('Discount') ? hash['Discount'] : SKIP
+      tax = hash.key?('Tax') ? hash['Tax'] : SKIP
+      returned = hash.key?('Returned') ? hash['Returned'] : SKIP
+      quantity = hash.key?('Quantity') ? hash['Quantity'] : SKIP
+
+      # Create object from extracted values.
+      ClientPurchaseRecord.new(sale,
+                               description,
+                               account_payment,
+                               price,
+                               amount_paid,
+                               discount,
+                               tax,
+                               returned,
+                               quantity)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sale: #{@sale}, description: #{@description}, account_payment:"\
+      " #{@account_payment}, price: #{@price}, amount_paid: #{@amount_paid}, discount:"\
+      " #{@discount}, tax: #{@tax}, returned: #{@returned}, quantity: #{@quantity}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sale: #{@sale.inspect}, description: #{@description.inspect},"\
+      " account_payment: #{@account_payment.inspect}, price: #{@price.inspect}, amount_paid:"\
+      " #{@amount_paid.inspect}, discount: #{@discount.inspect}, tax: #{@tax.inspect}, returned:"\
+      " #{@returned.inspect}, quantity: #{@quantity.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_relationship.rb

@@ -0,0 +1,109 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A relation between two clients.
+  class ClientRelationship < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The RSSID of the related client.
+    # @return [String]
+    attr_accessor :related_client_id
+
+    # The UniqueId of the related client.
+    # @return [Integer]
+    attr_accessor :related_unique_id
+
+    # Jim is a RelationshipName1 of John. John is a RelationshipName2 of Jim.
+    # @return [Relationship]
+    attr_accessor :relationship
+
+    # The name of the relationship of the related client.
+    # @return [String]
+    attr_accessor :relationship_name
+
+    # When true, the associated relationship is removed from the client’s list
+    # of relationships.
+    # This property is ignored in all other use cases.
+    # Default: *false*
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['related_client_id'] = 'RelatedClientId'
+      @_hash['related_unique_id'] = 'RelatedUniqueId'
+      @_hash['relationship'] = 'Relationship'
+      @_hash['relationship_name'] = 'RelationshipName'
+      @_hash['delete'] = 'Delete'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        related_client_id
+        related_unique_id
+        relationship
+        relationship_name
+        delete
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(related_client_id = SKIP, related_unique_id = SKIP,
+                   relationship = SKIP, relationship_name = SKIP, delete = SKIP)
+      @related_client_id = related_client_id unless related_client_id == SKIP
+      @related_unique_id = related_unique_id unless related_unique_id == SKIP
+      @relationship = relationship unless relationship == SKIP
+      @relationship_name = relationship_name unless relationship_name == SKIP
+      @delete = delete unless delete == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      related_client_id =
+        hash.key?('RelatedClientId') ? hash['RelatedClientId'] : SKIP
+      related_unique_id =
+        hash.key?('RelatedUniqueId') ? hash['RelatedUniqueId'] : SKIP
+      relationship = Relationship.from_hash(hash['Relationship']) if hash['Relationship']
+      relationship_name =
+        hash.key?('RelationshipName') ? hash['RelationshipName'] : SKIP
+      delete = hash.key?('Delete') ? hash['Delete'] : SKIP
+
+      # Create object from extracted values.
+      ClientRelationship.new(related_client_id,
+                             related_unique_id,
+                             relationship,
+                             relationship_name,
+                             delete)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} related_client_id: #{@related_client_id}, related_unique_id:"\
+      " #{@related_unique_id}, relationship: #{@relationship}, relationship_name:"\
+      " #{@relationship_name}, delete: #{@delete}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} related_client_id: #{@related_client_id.inspect}, related_unique_id:"\
+      " #{@related_unique_id.inspect}, relationship: #{@relationship.inspect}, relationship_name:"\
+      " #{@relationship_name.inspect}, delete: #{@delete.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_reward_transaction.rb

@@ -0,0 +1,132 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Contains information about the transaction details.
+  class ClientRewardTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time when the points were earned or redeemed in the site
+    # local time zone.
+    # @return [DateTime]
+    attr_accessor :action_date_time
+
+    # Indicates if rewards were earned or redeemed.
+    # @return [Action10Enum]
+    attr_accessor :action
+
+    # The source of the reward transaction.
+    # @return [String]
+    attr_accessor :source
+
+    # The unique identifier in the MINDBODY system for the **Source**.
+    # @return [Integer]
+    attr_accessor :source_id
+
+    # The date and time when earned points expire. This is calculated based on
+    # site and client rewards settings. This date will be in the site local time
+    # zone and may be **null**.
+    # @return [DateTime]
+    attr_accessor :expiration_date_time
+
+    # The amount of points the client earned or redeemed.
+    # @return [Integer]
+    attr_accessor :points
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action_date_time'] = 'ActionDateTime'
+      @_hash['action'] = 'Action'
+      @_hash['source'] = 'Source'
+      @_hash['source_id'] = 'SourceID'
+      @_hash['expiration_date_time'] = 'ExpirationDateTime'
+      @_hash['points'] = 'Points'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action_date_time
+        action
+        source
+        source_id
+        expiration_date_time
+        points
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action_date_time = SKIP, action = SKIP, source = SKIP,
+                   source_id = SKIP, expiration_date_time = SKIP, points = SKIP)
+      @action_date_time = action_date_time unless action_date_time == SKIP
+      @action = action unless action == SKIP
+      @source = source unless source == SKIP
+      @source_id = source_id unless source_id == SKIP
+      @expiration_date_time = expiration_date_time unless expiration_date_time == SKIP
+      @points = points unless points == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      action_date_time = if hash.key?('ActionDateTime')
+                           (DateTimeHelper.from_rfc3339(hash['ActionDateTime']) if hash['ActionDateTime'])
+                         else
+                           SKIP
+                         end
+      action = hash.key?('Action') ? hash['Action'] : SKIP
+      source = hash.key?('Source') ? hash['Source'] : SKIP
+      source_id = hash.key?('SourceID') ? hash['SourceID'] : SKIP
+      expiration_date_time = if hash.key?('ExpirationDateTime')
+                               (DateTimeHelper.from_rfc3339(hash['ExpirationDateTime']) if hash['ExpirationDateTime'])
+                             else
+                               SKIP
+                             end
+      points = hash.key?('Points') ? hash['Points'] : SKIP
+
+      # Create object from extracted values.
+      ClientRewardTransaction.new(action_date_time,
+                                  action,
+                                  source,
+                                  source_id,
+                                  expiration_date_time,
+                                  points)
+    end
+
+    def to_custom_action_date_time
+      DateTimeHelper.to_rfc3339(action_date_time)
+    end
+
+    def to_custom_expiration_date_time
+      DateTimeHelper.to_rfc3339(expiration_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action_date_time: #{@action_date_time}, action: #{@action}, source:"\
+      " #{@source}, source_id: #{@source_id}, expiration_date_time: #{@expiration_date_time},"\
+      " points: #{@points}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} action_date_time: #{@action_date_time.inspect}, action: #{@action.inspect},"\
+      " source: #{@source.inspect}, source_id: #{@source_id.inspect}, expiration_date_time:"\
+      " #{@expiration_date_time.inspect}, points: #{@points.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_service.rb

@@ -0,0 +1,228 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # A service that is on a client's account.
+  class ClientService < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date that this pricing option became active and could be used to pay
+    # for services.
+    # @return [DateTime]
+    attr_accessor :active_date
+
+    # The number of service sessions this pricing option contained when first
+    # purchased.
+    # @return [Integer]
+    attr_accessor :count
+
+    # When `true`, there are service sessions remaining on the pricing option
+    # that can be used pay for the current session.<br />
+    # When `false`, the client cannot use this pricing option to pay for other
+    # services.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :current
+
+    # The date when the pricing option expires and can no longer be used to pay
+    # for services, even if unused service sessions remain on the option;
+    # expressed as UTC.
+    # @return [DateTime]
+    attr_accessor :expiration_date
+
+    # The unique ID assigned to this pricing option, specific to when it was
+    # purchased by the client.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The unique ID of this pricing option, not specific to any client's
+    # purchase of it.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # The name of this pricing option.
+    # @return [String]
+    attr_accessor :name
+
+    # The date on which the client paid for this pricing option.
+    # @return [DateTime]
+    attr_accessor :payment_date
+
+    # The date on which the client paid for this pricing option.
+    # @return [Program]
+    attr_accessor :program
+
+    # The number of service sessions remaining in the pricing option that can
+    # still be used.
+    # @return [Integer]
+    attr_accessor :remaining
+
+    # The ID of the subscriber site associated with this pricing option.
+    # @return [Integer]
+    attr_accessor :site_id
+
+    # The action taken.
+    # @return [Action1Enum]
+    attr_accessor :action
+
+    # The Client ID assigned to this pricing option, specific to when it was
+    # purchased by the client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Identification for purchased service is returned or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :returned
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['active_date'] = 'ActiveDate'
+      @_hash['count'] = 'Count'
+      @_hash['current'] = 'Current'
+      @_hash['expiration_date'] = 'ExpirationDate'
+      @_hash['id'] = 'Id'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['name'] = 'Name'
+      @_hash['payment_date'] = 'PaymentDate'
+      @_hash['program'] = 'Program'
+      @_hash['remaining'] = 'Remaining'
+      @_hash['site_id'] = 'SiteId'
+      @_hash['action'] = 'Action'
+      @_hash['client_id'] = 'ClientID'
+      @_hash['returned'] = 'Returned'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        active_date
+        count
+        current
+        expiration_date
+        id
+        product_id
+        name
+        payment_date
+        program
+        remaining
+        site_id
+        action
+        client_id
+        returned
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(active_date = SKIP, count = SKIP, current = SKIP,
+                   expiration_date = SKIP, id = SKIP, product_id = SKIP,
+                   name = SKIP, payment_date = SKIP, program = SKIP,
+                   remaining = SKIP, site_id = SKIP, action = SKIP,
+                   client_id = SKIP, returned = SKIP)
+      @active_date = active_date unless active_date == SKIP
+      @count = count unless count == SKIP
+      @current = current unless current == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @id = id unless id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == SKIP
+      @payment_date = payment_date unless payment_date == SKIP
+      @program = program unless program == SKIP
+      @remaining = remaining unless remaining == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @action = action unless action == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @returned = returned unless returned == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      active_date = if hash.key?('ActiveDate')
+                      (DateTimeHelper.from_rfc3339(hash['ActiveDate']) if hash['ActiveDate'])
+                    else
+                      SKIP
+                    end
+      count = hash.key?('Count') ? hash['Count'] : SKIP
+      current = hash.key?('Current') ? hash['Current'] : SKIP
+      expiration_date = if hash.key?('ExpirationDate')
+                          (DateTimeHelper.from_rfc3339(hash['ExpirationDate']) if hash['ExpirationDate'])
+                        else
+                          SKIP
+                        end
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      payment_date = if hash.key?('PaymentDate')
+                       (DateTimeHelper.from_rfc3339(hash['PaymentDate']) if hash['PaymentDate'])
+                     else
+                       SKIP
+                     end
+      program = Program.from_hash(hash['Program']) if hash['Program']
+      remaining = hash.key?('Remaining') ? hash['Remaining'] : SKIP
+      site_id = hash.key?('SiteId') ? hash['SiteId'] : SKIP
+      action = hash.key?('Action') ? hash['Action'] : SKIP
+      client_id = hash.key?('ClientID') ? hash['ClientID'] : SKIP
+      returned = hash.key?('Returned') ? hash['Returned'] : SKIP
+
+      # Create object from extracted values.
+      ClientService.new(active_date,
+                        count,
+                        current,
+                        expiration_date,
+                        id,
+                        product_id,
+                        name,
+                        payment_date,
+                        program,
+                        remaining,
+                        site_id,
+                        action,
+                        client_id,
+                        returned)
+    end
+
+    def to_custom_active_date
+      DateTimeHelper.to_rfc3339(active_date)
+    end
+
+    def to_custom_expiration_date
+      DateTimeHelper.to_rfc3339(expiration_date)
+    end
+
+    def to_custom_payment_date
+      DateTimeHelper.to_rfc3339(payment_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} active_date: #{@active_date}, count: #{@count}, current: #{@current},"\
+      " expiration_date: #{@expiration_date}, id: #{@id}, product_id: #{@product_id}, name:"\
+      " #{@name}, payment_date: #{@payment_date}, program: #{@program}, remaining: #{@remaining},"\
+      " site_id: #{@site_id}, action: #{@action}, client_id: #{@client_id}, returned:"\
+      " #{@returned}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} active_date: #{@active_date.inspect}, count: #{@count.inspect}, current:"\
+      " #{@current.inspect}, expiration_date: #{@expiration_date.inspect}, id: #{@id.inspect},"\
+      " product_id: #{@product_id.inspect}, name: #{@name.inspect}, payment_date:"\
+      " #{@payment_date.inspect}, program: #{@program.inspect}, remaining: #{@remaining.inspect},"\
+      " site_id: #{@site_id.inspect}, action: #{@action.inspect}, client_id:"\
+      " #{@client_id.inspect}, returned: #{@returned.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_suspension_info.rb

@@ -0,0 +1,86 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A Client DTO with Suspension Informatoin
+  class ClientSuspensionInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When 'true', indicates that the client is suspended from booking
+    # @return [TrueClass | FalseClass]
+    attr_accessor :booking_suspended
+
+    # Indicates the Date that BookingSuspension starts 'YYYY-MM-DD'
+    # @return [String]
+    attr_accessor :suspension_start_date
+
+    # Indicates the Date that BookingSuspension ends 'YYYY-MM-DD'
+    # @return [String]
+    attr_accessor :suspension_end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['booking_suspended'] = 'BookingSuspended'
+      @_hash['suspension_start_date'] = 'SuspensionStartDate'
+      @_hash['suspension_end_date'] = 'SuspensionEndDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        booking_suspended
+        suspension_start_date
+        suspension_end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(booking_suspended = SKIP, suspension_start_date = SKIP,
+                   suspension_end_date = SKIP)
+      @booking_suspended = booking_suspended unless booking_suspended == SKIP
+      @suspension_start_date = suspension_start_date unless suspension_start_date == SKIP
+      @suspension_end_date = suspension_end_date unless suspension_end_date == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      booking_suspended =
+        hash.key?('BookingSuspended') ? hash['BookingSuspended'] : SKIP
+      suspension_start_date =
+        hash.key?('SuspensionStartDate') ? hash['SuspensionStartDate'] : SKIP
+      suspension_end_date =
+        hash.key?('SuspensionEndDate') ? hash['SuspensionEndDate'] : SKIP
+
+      # Create object from extracted values.
+      ClientSuspensionInfo.new(booking_suspended,
+                               suspension_start_date,
+                               suspension_end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} booking_suspended: #{@booking_suspended}, suspension_start_date:"\
+      " #{@suspension_start_date}, suspension_end_date: #{@suspension_end_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} booking_suspended: #{@booking_suspended.inspect}, suspension_start_date:"\
+      " #{@suspension_start_date.inspect}, suspension_end_date: #{@suspension_end_date.inspect}>"
+    end
+  end
+end