mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/sale.rb

@@ -0,0 +1,210 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Contains the Sale details.
+  class Sale < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The sale ID.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The date the item was sold.
+    # @return [DateTime]
+    attr_accessor :sale_date
+
+    # The time the item was sold.
+    # @return [String]
+    attr_accessor :sale_time
+
+    # The date and time the item was sold.
+    # @return [DateTime]
+    attr_accessor :sale_date_time
+
+    # The date and time the item was sold originally.
+    # @return [DateTime]
+    attr_accessor :original_sale_date_time
+
+    # The sales representative ID
+    # @return [Integer]
+    attr_accessor :sales_rep_id
+
+    # The ID of the client who made the purchase.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Recipient Client Id
+    # @return [Integer]
+    attr_accessor :recipient_client_id
+
+    # Contains the `PurchasedItem` objects that describe the purchased items.
+    # @return [Array[PurchasedItem]]
+    attr_accessor :purchased_items
+
+    # The ID of the location where the sale takes place.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Contains the `SalePayment` objects that describe the payments that
+    # contributed to this sale.
+    # @return [Array[SalePayment]]
+    attr_accessor :payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['sale_date'] = 'SaleDate'
+      @_hash['sale_time'] = 'SaleTime'
+      @_hash['sale_date_time'] = 'SaleDateTime'
+      @_hash['original_sale_date_time'] = 'OriginalSaleDateTime'
+      @_hash['sales_rep_id'] = 'SalesRepId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['recipient_client_id'] = 'RecipientClientId'
+      @_hash['purchased_items'] = 'PurchasedItems'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['payments'] = 'Payments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        sale_date
+        sale_time
+        sale_date_time
+        original_sale_date_time
+        sales_rep_id
+        client_id
+        recipient_client_id
+        purchased_items
+        location_id
+        payments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, sale_date = SKIP, sale_time = SKIP,
+                   sale_date_time = SKIP, original_sale_date_time = SKIP,
+                   sales_rep_id = SKIP, client_id = SKIP,
+                   recipient_client_id = SKIP, purchased_items = SKIP,
+                   location_id = SKIP, payments = SKIP)
+      @id = id unless id == SKIP
+      @sale_date = sale_date unless sale_date == SKIP
+      @sale_time = sale_time unless sale_time == SKIP
+      @sale_date_time = sale_date_time unless sale_date_time == SKIP
+      @original_sale_date_time = original_sale_date_time unless original_sale_date_time == SKIP
+      @sales_rep_id = sales_rep_id unless sales_rep_id == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @recipient_client_id = recipient_client_id unless recipient_client_id == SKIP
+      @purchased_items = purchased_items unless purchased_items == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @payments = payments unless payments == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      sale_date = if hash.key?('SaleDate')
+                    (DateTimeHelper.from_rfc3339(hash['SaleDate']) if hash['SaleDate'])
+                  else
+                    SKIP
+                  end
+      sale_time = hash.key?('SaleTime') ? hash['SaleTime'] : SKIP
+      sale_date_time = if hash.key?('SaleDateTime')
+                         (DateTimeHelper.from_rfc3339(hash['SaleDateTime']) if hash['SaleDateTime'])
+                       else
+                         SKIP
+                       end
+      original_sale_date_time = if hash.key?('OriginalSaleDateTime')
+                                  (DateTimeHelper.from_rfc3339(hash['OriginalSaleDateTime']) if hash['OriginalSaleDateTime'])
+                                else
+                                  SKIP
+                                end
+      sales_rep_id = hash.key?('SalesRepId') ? hash['SalesRepId'] : SKIP
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      recipient_client_id =
+        hash.key?('RecipientClientId') ? hash['RecipientClientId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      purchased_items = nil
+      unless hash['PurchasedItems'].nil?
+        purchased_items = []
+        hash['PurchasedItems'].each do |structure|
+          purchased_items << (PurchasedItem.from_hash(structure) if structure)
+        end
+      end
+
+      purchased_items = SKIP unless hash.key?('PurchasedItems')
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['Payments'].nil?
+        payments = []
+        hash['Payments'].each do |structure|
+          payments << (SalePayment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('Payments')
+
+      # Create object from extracted values.
+      Sale.new(id,
+               sale_date,
+               sale_time,
+               sale_date_time,
+               original_sale_date_time,
+               sales_rep_id,
+               client_id,
+               recipient_client_id,
+               purchased_items,
+               location_id,
+               payments)
+    end
+
+    def to_custom_sale_date
+      DateTimeHelper.to_rfc3339(sale_date)
+    end
+
+    def to_custom_sale_date_time
+      DateTimeHelper.to_rfc3339(sale_date_time)
+    end
+
+    def to_custom_original_sale_date_time
+      DateTimeHelper.to_rfc3339(original_sale_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, sale_date: #{@sale_date}, sale_time: #{@sale_time},"\
+      " sale_date_time: #{@sale_date_time}, original_sale_date_time: #{@original_sale_date_time},"\
+      " sales_rep_id: #{@sales_rep_id}, client_id: #{@client_id}, recipient_client_id:"\
+      " #{@recipient_client_id}, purchased_items: #{@purchased_items}, location_id:"\
+      " #{@location_id}, payments: #{@payments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, sale_date: #{@sale_date.inspect}, sale_time:"\
+      " #{@sale_time.inspect}, sale_date_time: #{@sale_date_time.inspect},"\
+      " original_sale_date_time: #{@original_sale_date_time.inspect}, sales_rep_id:"\
+      " #{@sales_rep_id.inspect}, client_id: #{@client_id.inspect}, recipient_client_id:"\
+      " #{@recipient_client_id.inspect}, purchased_items: #{@purchased_items.inspect},"\
+      " location_id: #{@location_id.inspect}, payments: #{@payments.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/sale_payment.rb

@@ -0,0 +1,114 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # SalePayment Model.
+  class SalePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for this payment.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The total amount of sales that were made on the sale date, including all
+    # payment methods that were used and taxes that were collected.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The method used to make this payment.
+    # @return [Integer]
+    attr_accessor :method
+
+    # The payment method type used for the client’s purchase.
+    # @return [String]
+    attr_accessor :type
+
+    # Payment notes that are entered under the selected payment method in the
+    # Retail screen before completing the sale.
+    # @return [String]
+    attr_accessor :notes
+
+    # The ID of transaction. Use this ID when calling the GET Transactions
+    # endpoint.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['amount'] = 'Amount'
+      @_hash['method'] = 'Method'
+      @_hash['type'] = 'Type'
+      @_hash['notes'] = 'Notes'
+      @_hash['transaction_id'] = 'TransactionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        amount
+        method
+        type
+        notes
+        transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, amount = SKIP, method = SKIP, type = SKIP,
+                   notes = SKIP, transaction_id = SKIP)
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @method = method unless method == SKIP
+      @type = type unless type == SKIP
+      @notes = notes unless notes == SKIP
+      @transaction_id = transaction_id unless transaction_id == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      amount = hash.key?('Amount') ? hash['Amount'] : SKIP
+      method = hash.key?('Method') ? hash['Method'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      notes = hash.key?('Notes') ? hash['Notes'] : SKIP
+      transaction_id = hash.key?('TransactionId') ? hash['TransactionId'] : SKIP
+
+      # Create object from extracted values.
+      SalePayment.new(id,
+                      amount,
+                      method,
+                      type,
+                      notes,
+                      transaction_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, amount: #{@amount}, method: #{@method}, type: #{@type}, notes:"\
+      " #{@notes}, transaction_id: #{@transaction_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, amount: #{@amount.inspect}, method: #{@method.inspect},"\
+      " type: #{@type.inspect}, notes: #{@notes.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/sales_rep.rb

@@ -0,0 +1,107 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # SalesRep Model.
+  class SalesRep < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first name of the sales representative.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The staff ID of the sales representative.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The last name of the sales representative.
+    # @return [String]
+    attr_accessor :last_name
+
+    # This value is the number that identifies the type of sales representative
+    # assigned to this client. One to six types of sales representatives can be
+    # assigned to a client at any given time, depending on site settings.
+    # @return [Integer]
+    attr_accessor :sales_rep_number
+
+    # A list of the different types of sales representative functions assigned
+    # to this staff member.
+    # @return [Array[Integer]]
+    attr_accessor :sales_rep_numbers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'FirstName'
+      @_hash['id'] = 'Id'
+      @_hash['last_name'] = 'LastName'
+      @_hash['sales_rep_number'] = 'SalesRepNumber'
+      @_hash['sales_rep_numbers'] = 'SalesRepNumbers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        id
+        last_name
+        sales_rep_number
+        sales_rep_numbers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, id = SKIP, last_name = SKIP,
+                   sales_rep_number = SKIP, sales_rep_numbers = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @id = id unless id == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @sales_rep_number = sales_rep_number unless sales_rep_number == SKIP
+      @sales_rep_numbers = sales_rep_numbers unless sales_rep_numbers == 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.
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      sales_rep_number =
+        hash.key?('SalesRepNumber') ? hash['SalesRepNumber'] : SKIP
+      sales_rep_numbers =
+        hash.key?('SalesRepNumbers') ? hash['SalesRepNumbers'] : SKIP
+
+      # Create object from extracted values.
+      SalesRep.new(first_name,
+                   id,
+                   last_name,
+                   sales_rep_number,
+                   sales_rep_numbers)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name}, id: #{@id}, last_name: #{@last_name},"\
+      " sales_rep_number: #{@sales_rep_number}, sales_rep_numbers: #{@sales_rep_numbers}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name.inspect}, id: #{@id.inspect}, last_name:"\
+      " #{@last_name.inspect}, sales_rep_number: #{@sales_rep_number.inspect}, sales_rep_numbers:"\
+      " #{@sales_rep_numbers.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/sales_rep_response.rb

@@ -0,0 +1,93 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # This is the sales rep DTO
+  class SalesRepResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique Id of the sales rep
+    # @return [Integer]
+    attr_accessor :id
+
+    # The firstname of the sales rep
+    # @return [String]
+    attr_accessor :first_name
+
+    # The lastname of the sales rep
+    # @return [String]
+    attr_accessor :last_name
+
+    # The sales rep Ids that are assigned to the rep
+    # @return [Array[Integer]]
+    attr_accessor :sales_rep_numbers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['sales_rep_numbers'] = 'SalesRepNumbers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        first_name
+        last_name
+        sales_rep_numbers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, first_name = SKIP, last_name = SKIP,
+                   sales_rep_numbers = SKIP)
+      @id = id unless id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @sales_rep_numbers = sales_rep_numbers unless sales_rep_numbers == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      sales_rep_numbers =
+        hash.key?('SalesRepNumbers') ? hash['SalesRepNumbers'] : SKIP
+
+      # Create object from extracted values.
+      SalesRepResponse.new(id,
+                           first_name,
+                           last_name,
+                           sales_rep_numbers)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, first_name: #{@first_name}, last_name: #{@last_name},"\
+      " sales_rep_numbers: #{@sales_rep_numbers}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, first_name: #{@first_name.inspect}, last_name:"\
+      " #{@last_name.inspect}, sales_rep_numbers: #{@sales_rep_numbers.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/schedule_type1_enum.rb

@@ -0,0 +1,57 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Filters on the provided the schedule type. Either `SessionTypeIds` or
+  # `ScheduleType` must be provided.
+  class ScheduleType1Enum
+    SCHEDULE_TYPE1_ENUM = [
+      # TODO: Write general description for ALL
+      ALL = 'All'.freeze,
+
+      # TODO: Write general description for CLASS
+      CLASS = 'Class'.freeze,
+
+      # TODO: Write general description for ENROLLMENT
+      ENROLLMENT = 'Enrollment'.freeze,
+
+      # TODO: Write general description for APPOINTMENT
+      APPOINTMENT = 'Appointment'.freeze,
+
+      # TODO: Write general description for RESOURCE
+      RESOURCE = 'Resource'.freeze,
+
+      # TODO: Write general description for MEDIA
+      MEDIA = 'Media'.freeze,
+
+      # TODO: Write general description for ARRIVAL
+      ARRIVAL = 'Arrival'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEDULE_TYPE1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'class' then CLASS
+      when 'enrollment' then ENROLLMENT
+      when 'appointment' then APPOINTMENT
+      when 'resource' then RESOURCE
+      when 'media' then MEDIA
+      when 'arrival' then ARRIVAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/schedule_type2_enum.rb

@@ -0,0 +1,56 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # ScheduleType2.
+  class ScheduleType2Enum
+    SCHEDULE_TYPE2_ENUM = [
+      # TODO: Write general description for ALL
+      ALL = 'All'.freeze,
+
+      # TODO: Write general description for DROPIN
+      DROPIN = 'DropIn'.freeze,
+
+      # TODO: Write general description for ENROLLMENT
+      ENROLLMENT = 'Enrollment'.freeze,
+
+      # TODO: Write general description for APPOINTMENT
+      APPOINTMENT = 'Appointment'.freeze,
+
+      # TODO: Write general description for RESOURCE
+      RESOURCE = 'Resource'.freeze,
+
+      # TODO: Write general description for MEDIA
+      MEDIA = 'Media'.freeze,
+
+      # TODO: Write general description for ARRIVAL
+      ARRIVAL = 'Arrival'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEDULE_TYPE2_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'dropin' then DROPIN
+      when 'enrollment' then ENROLLMENT
+      when 'appointment' then APPOINTMENT
+      when 'resource' then RESOURCE
+      when 'media' then MEDIA
+      when 'arrival' then ARRIVAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/schedule_type3_enum.rb

@@ -0,0 +1,57 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A schedule type used to filter the returned results. Possible values are: *
+  # All * Class * Enrollment * Appointment * Resource * Media * Arrival
+  class ScheduleType3Enum
+    SCHEDULE_TYPE3_ENUM = [
+      # TODO: Write general description for ALL
+      ALL = 'All'.freeze,
+
+      # TODO: Write general description for CLASS
+      CLASS = 'Class'.freeze,
+
+      # TODO: Write general description for ENROLLMENT
+      ENROLLMENT = 'Enrollment'.freeze,
+
+      # TODO: Write general description for APPOINTMENT
+      APPOINTMENT = 'Appointment'.freeze,
+
+      # TODO: Write general description for RESOURCE
+      RESOURCE = 'Resource'.freeze,
+
+      # TODO: Write general description for MEDIA
+      MEDIA = 'Media'.freeze,
+
+      # TODO: Write general description for ARRIVAL
+      ARRIVAL = 'Arrival'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SCHEDULE_TYPE3_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'all' then ALL
+      when 'class' then CLASS
+      when 'enrollment' then ENROLLMENT
+      when 'appointment' then APPOINTMENT
+      when 'resource' then RESOURCE
+      when 'media' then MEDIA
+      when 'arrival' then ARRIVAL
+      else
+        default_value
+      end
+    end
+  end
+end