mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/staff_session_type.rb

@@ -0,0 +1,205 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # StaffSessionType Model.
+  class StaffSessionType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The staff member Id
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # Contains the class description session type.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # This session type’s unique Id.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of this session type.
+    # @return [String]
+    attr_accessor :name
+
+    # The number of sessions that this session type deducts from the pricing
+    # option used to pay for this type of session.
+    # @return [Integer]
+    attr_accessor :num_deducted
+
+    # This session type’s service category Id.
+    # @return [Integer]
+    attr_accessor :program_id
+
+    # This session type’s category.
+    # @return [String]
+    attr_accessor :category
+
+    # This session type’s category Id.
+    # @return [Integer]
+    attr_accessor :category_id
+
+    # This session type’s subcategory.
+    # @return [String]
+    attr_accessor :subcategory
+
+    # This session type’s subcategory Id.
+    # @return [Integer]
+    attr_accessor :subcategory_id
+
+    # This session type’s subcategory Id.
+    # @return [Integer]
+    attr_accessor :time_length
+
+    # Prep time in minutes
+    # @return [Integer]
+    attr_accessor :prep_time
+
+    # Finish time in minutes
+    # @return [Integer]
+    attr_accessor :finish_time
+
+    # The pay rate type
+    # @return [String]
+    attr_accessor :pay_rate_type
+
+    # The pay rate amount
+    # @return [Float]
+    attr_accessor :pay_rate_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['type'] = 'Type'
+      @_hash['id'] = 'Id'
+      @_hash['name'] = 'Name'
+      @_hash['num_deducted'] = 'NumDeducted'
+      @_hash['program_id'] = 'ProgramId'
+      @_hash['category'] = 'Category'
+      @_hash['category_id'] = 'CategoryId'
+      @_hash['subcategory'] = 'Subcategory'
+      @_hash['subcategory_id'] = 'SubcategoryId'
+      @_hash['time_length'] = 'TimeLength'
+      @_hash['prep_time'] = 'PrepTime'
+      @_hash['finish_time'] = 'FinishTime'
+      @_hash['pay_rate_type'] = 'PayRateType'
+      @_hash['pay_rate_amount'] = 'PayRateAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        type
+        id
+        name
+        num_deducted
+        program_id
+        category
+        category_id
+        subcategory
+        subcategory_id
+        time_length
+        prep_time
+        finish_time
+        pay_rate_type
+        pay_rate_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, type = SKIP, id = SKIP, name = SKIP,
+                   num_deducted = SKIP, program_id = SKIP, category = SKIP,
+                   category_id = SKIP, subcategory = SKIP,
+                   subcategory_id = SKIP, time_length = SKIP, prep_time = SKIP,
+                   finish_time = SKIP, pay_rate_type = SKIP,
+                   pay_rate_amount = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @type = type unless type == SKIP
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @num_deducted = num_deducted unless num_deducted == SKIP
+      @program_id = program_id unless program_id == SKIP
+      @category = category unless category == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @subcategory = subcategory unless subcategory == SKIP
+      @subcategory_id = subcategory_id unless subcategory_id == SKIP
+      @time_length = time_length unless time_length == SKIP
+      @prep_time = prep_time unless prep_time == SKIP
+      @finish_time = finish_time unless finish_time == SKIP
+      @pay_rate_type = pay_rate_type unless pay_rate_type == SKIP
+      @pay_rate_amount = pay_rate_amount unless pay_rate_amount == 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.
+      staff_id = hash.key?('StaffId') ? hash['StaffId'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      num_deducted = hash.key?('NumDeducted') ? hash['NumDeducted'] : SKIP
+      program_id = hash.key?('ProgramId') ? hash['ProgramId'] : SKIP
+      category = hash.key?('Category') ? hash['Category'] : SKIP
+      category_id = hash.key?('CategoryId') ? hash['CategoryId'] : SKIP
+      subcategory = hash.key?('Subcategory') ? hash['Subcategory'] : SKIP
+      subcategory_id = hash.key?('SubcategoryId') ? hash['SubcategoryId'] : SKIP
+      time_length = hash.key?('TimeLength') ? hash['TimeLength'] : SKIP
+      prep_time = hash.key?('PrepTime') ? hash['PrepTime'] : SKIP
+      finish_time = hash.key?('FinishTime') ? hash['FinishTime'] : SKIP
+      pay_rate_type = hash.key?('PayRateType') ? hash['PayRateType'] : SKIP
+      pay_rate_amount =
+        hash.key?('PayRateAmount') ? hash['PayRateAmount'] : SKIP
+
+      # Create object from extracted values.
+      StaffSessionType.new(staff_id,
+                           type,
+                           id,
+                           name,
+                           num_deducted,
+                           program_id,
+                           category,
+                           category_id,
+                           subcategory,
+                           subcategory_id,
+                           time_length,
+                           prep_time,
+                           finish_time,
+                           pay_rate_type,
+                           pay_rate_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} staff_id: #{@staff_id}, type: #{@type}, id: #{@id}, name: #{@name},"\
+      " num_deducted: #{@num_deducted}, program_id: #{@program_id}, category: #{@category},"\
+      " category_id: #{@category_id}, subcategory: #{@subcategory}, subcategory_id:"\
+      " #{@subcategory_id}, time_length: #{@time_length}, prep_time: #{@prep_time}, finish_time:"\
+      " #{@finish_time}, pay_rate_type: #{@pay_rate_type}, pay_rate_amount: #{@pay_rate_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} staff_id: #{@staff_id.inspect}, type: #{@type.inspect}, id: #{@id.inspect},"\
+      " name: #{@name.inspect}, num_deducted: #{@num_deducted.inspect}, program_id:"\
+      " #{@program_id.inspect}, category: #{@category.inspect}, category_id:"\
+      " #{@category_id.inspect}, subcategory: #{@subcategory.inspect}, subcategory_id:"\
+      " #{@subcategory_id.inspect}, time_length: #{@time_length.inspect}, prep_time:"\
+      " #{@prep_time.inspect}, finish_time: #{@finish_time.inspect}, pay_rate_type:"\
+      " #{@pay_rate_type.inspect}, pay_rate_amount: #{@pay_rate_amount.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/staff_setting.rb

@@ -0,0 +1,84 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # contains the information about the staff settings.
+  class StaffSetting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, `DisplayName` of the staff will be displayed.
+    # When `false`, `DisplayName` will be displayed as null.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_staff_nicknames
+
+    # When `true`, indicates that the Name contains both the `FirstName` and
+    # `LastName` of the staff.
+    # When `false`, indicates that the Name contains only the `FirstName` of the
+    # staff.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_staff_last_names_on_schedules
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['use_staff_nicknames'] = 'UseStaffNicknames'
+      @_hash['show_staff_last_names_on_schedules'] =
+        'ShowStaffLastNamesOnSchedules'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        use_staff_nicknames
+        show_staff_last_names_on_schedules
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(use_staff_nicknames = SKIP,
+                   show_staff_last_names_on_schedules = SKIP)
+      @use_staff_nicknames = use_staff_nicknames unless use_staff_nicknames == SKIP
+      unless show_staff_last_names_on_schedules == SKIP
+        @show_staff_last_names_on_schedules =
+          show_staff_last_names_on_schedules
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      use_staff_nicknames =
+        hash.key?('UseStaffNicknames') ? hash['UseStaffNicknames'] : SKIP
+      show_staff_last_names_on_schedules =
+        hash.key?('ShowStaffLastNamesOnSchedules') ? hash['ShowStaffLastNamesOnSchedules'] : SKIP
+
+      # Create object from extracted values.
+      StaffSetting.new(use_staff_nicknames,
+                       show_staff_last_names_on_schedules)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} use_staff_nicknames: #{@use_staff_nicknames},"\
+      " show_staff_last_names_on_schedules: #{@show_staff_last_names_on_schedules}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} use_staff_nicknames: #{@use_staff_nicknames.inspect},"\
+      " show_staff_last_names_on_schedules: #{@show_staff_last_names_on_schedules.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/status1_enum.rb

@@ -0,0 +1,56 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The status of this appointment.
+  class Status1Enum
+    STATUS1_ENUM = [
+      # TODO: Write general description for BOOKED
+      BOOKED = 'Booked'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze,
+
+      # TODO: Write general description for CONFIRMED
+      CONFIRMED = 'Confirmed'.freeze,
+
+      # TODO: Write general description for ARRIVED
+      ARRIVED = 'Arrived'.freeze,
+
+      # TODO: Write general description for NOSHOW
+      NOSHOW = 'NoShow'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'Cancelled'.freeze,
+
+      # TODO: Write general description for LATECANCELLED
+      LATECANCELLED = 'LateCancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = BOOKED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'booked' then BOOKED
+      when 'completed' then COMPLETED
+      when 'confirmed' then CONFIRMED
+      when 'arrived' then ARRIVED
+      when 'noshow' then NOSHOW
+      when 'cancelled' then CANCELLED
+      when 'latecancelled' then LATECANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/status_enum.rb

@@ -0,0 +1,66 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The status of this appointment. Possible values are: * None * Requested *
+  # Booked * Completed * Confirmed * Arrived * NoShow * Cancelled *
+  # LateCancelled
+  class StatusEnum
+    STATUS_ENUM = [
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for REQUESTED
+      REQUESTED = 'Requested'.freeze,
+
+      # TODO: Write general description for BOOKED
+      BOOKED = 'Booked'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze,
+
+      # TODO: Write general description for CONFIRMED
+      CONFIRMED = 'Confirmed'.freeze,
+
+      # TODO: Write general description for ARRIVED
+      ARRIVED = 'Arrived'.freeze,
+
+      # TODO: Write general description for NOSHOW
+      NOSHOW = 'NoShow'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'Cancelled'.freeze,
+
+      # TODO: Write general description for LATECANCELLED
+      LATECANCELLED = 'LateCancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'none' then NONE
+      when 'requested' then REQUESTED
+      when 'booked' then BOOKED
+      when 'completed' then COMPLETED
+      when 'confirmed' then CONFIRMED
+      when 'arrived' then ARRIVED
+      when 'noshow' then NOSHOW
+      when 'cancelled' then CANCELLED
+      when 'latecancelled' then LATECANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/stored_card_info.rb

@@ -0,0 +1,62 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # StoredCardInfo Model.
+  class StoredCardInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_four
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last_four'] = 'LastFour'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_four
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last_four = SKIP)
+      @last_four = last_four unless last_four == 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.
+      last_four = hash.key?('LastFour') ? hash['LastFour'] : SKIP
+
+      # Create object from extracted values.
+      StoredCardInfo.new(last_four)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last_four: #{@last_four}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last_four: #{@last_four.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/sub_category.rb

@@ -0,0 +1,82 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # SubCategory Model.
+  class SubCategory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Id of the subcategory.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of the subcategory.
+    # @return [String]
+    attr_accessor :sub_category_name
+
+    # When `true`, indicates that the subcategory is active.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['sub_category_name'] = 'SubCategoryName'
+      @_hash['active'] = 'Active'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        sub_category_name
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, sub_category_name = SKIP, active = SKIP)
+      @id = id unless id == SKIP
+      @sub_category_name = sub_category_name unless sub_category_name == SKIP
+      @active = active unless active == 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
+      sub_category_name =
+        hash.key?('SubCategoryName') ? hash['SubCategoryName'] : SKIP
+      active = hash.key?('Active') ? hash['Active'] : SKIP
+
+      # Create object from extracted values.
+      SubCategory.new(id,
+                      sub_category_name,
+                      active)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, sub_category_name: #{@sub_category_name}, active: #{@active}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, sub_category_name: #{@sub_category_name.inspect},"\
+      " active: #{@active.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/substitute_class_teacher_request.rb

@@ -0,0 +1,127 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # SubstituteClassTeacherRequest Model.
+  class SubstituteClassTeacherRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the class to which a substitute teacher needs to be assigned.
+    # @return [Integer]
+    attr_accessor :class_id
+
+    # The staff ID of the teacher to substitute.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # When `true`, overrides any conflicts in the schedule.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :override_conflicts
+
+    # When `true`, sends the client an automatic email about the substitution,
+    # if the client has opted to receive email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_client_email
+
+    # When `true`, sends the originally scheduled teacher an automatic email
+    # about the substitution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_original_teacher_email
+
+    # When `true`, sends the substituted teacher an automatic email about the
+    # substitution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_substitute_teacher_email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['class_id'] = 'ClassId'
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['override_conflicts'] = 'OverrideConflicts'
+      @_hash['send_client_email'] = 'SendClientEmail'
+      @_hash['send_original_teacher_email'] = 'SendOriginalTeacherEmail'
+      @_hash['send_substitute_teacher_email'] = 'SendSubstituteTeacherEmail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        override_conflicts
+        send_client_email
+        send_original_teacher_email
+        send_substitute_teacher_email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(class_id = nil, staff_id = nil, override_conflicts = SKIP,
+                   send_client_email = SKIP, send_original_teacher_email = SKIP,
+                   send_substitute_teacher_email = SKIP)
+      @class_id = class_id
+      @staff_id = staff_id
+      @override_conflicts = override_conflicts unless override_conflicts == SKIP
+      @send_client_email = send_client_email unless send_client_email == SKIP
+      unless send_original_teacher_email == SKIP
+        @send_original_teacher_email =
+          send_original_teacher_email
+      end
+      unless send_substitute_teacher_email == SKIP
+        @send_substitute_teacher_email =
+          send_substitute_teacher_email
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      class_id = hash.key?('ClassId') ? hash['ClassId'] : nil
+      staff_id = hash.key?('StaffId') ? hash['StaffId'] : nil
+      override_conflicts =
+        hash.key?('OverrideConflicts') ? hash['OverrideConflicts'] : SKIP
+      send_client_email =
+        hash.key?('SendClientEmail') ? hash['SendClientEmail'] : SKIP
+      send_original_teacher_email =
+        hash.key?('SendOriginalTeacherEmail') ? hash['SendOriginalTeacherEmail'] : SKIP
+      send_substitute_teacher_email =
+        hash.key?('SendSubstituteTeacherEmail') ? hash['SendSubstituteTeacherEmail'] : SKIP
+
+      # Create object from extracted values.
+      SubstituteClassTeacherRequest.new(class_id,
+                                        staff_id,
+                                        override_conflicts,
+                                        send_client_email,
+                                        send_original_teacher_email,
+                                        send_substitute_teacher_email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} class_id: #{@class_id}, staff_id: #{@staff_id}, override_conflicts:"\
+      " #{@override_conflicts}, send_client_email: #{@send_client_email},"\
+      " send_original_teacher_email: #{@send_original_teacher_email},"\
+      " send_substitute_teacher_email: #{@send_substitute_teacher_email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} class_id: #{@class_id.inspect}, staff_id: #{@staff_id.inspect},"\
+      " override_conflicts: #{@override_conflicts.inspect}, send_client_email:"\
+      " #{@send_client_email.inspect}, send_original_teacher_email:"\
+      " #{@send_original_teacher_email.inspect}, send_substitute_teacher_email:"\
+      " #{@send_substitute_teacher_email.inspect}>"
+    end
+  end
+end