mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/appointment_add_on.rb

@@ -0,0 +1,103 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AppointmentAddOn Model.
+  class AppointmentAddOn < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this add-on.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of this add-on.
+    # @return [String]
+    attr_accessor :name
+
+    # The number of sessions that this add-on deducts from the pricing option
+    # used to pay for this add-on.
+    # @return [Integer]
+    attr_accessor :num_deducted
+
+    # This ID of this add-on’s category.
+    # @return [Integer]
+    attr_accessor :category_id
+
+    # The name of this add-on’s category.
+    # @return [String]
+    attr_accessor :category
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['name'] = 'Name'
+      @_hash['num_deducted'] = 'NumDeducted'
+      @_hash['category_id'] = 'CategoryId'
+      @_hash['category'] = 'Category'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        num_deducted
+        category_id
+        category
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP, num_deducted = SKIP,
+                   category_id = SKIP, category = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @num_deducted = num_deducted unless num_deducted == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @category = category unless category == 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
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      num_deducted = hash.key?('NumDeducted') ? hash['NumDeducted'] : SKIP
+      category_id = hash.key?('CategoryId') ? hash['CategoryId'] : SKIP
+      category = hash.key?('Category') ? hash['Category'] : SKIP
+
+      # Create object from extracted values.
+      AppointmentAddOn.new(id,
+                           name,
+                           num_deducted,
+                           category_id,
+                           category)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, num_deducted: #{@num_deducted}, category_id:"\
+      " #{@category_id}, category: #{@category}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, num_deducted:"\
+      " #{@num_deducted.inspect}, category_id: #{@category_id.inspect}, category:"\
+      " #{@category.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/appointment_gender_preference1_enum.rb

@@ -0,0 +1,41 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The gender of staff member with whom the client prefers to book
+  # appointments.
+  class AppointmentGenderPreference1Enum
+    APPOINTMENT_GENDER_PREFERENCE1_ENUM = [
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for FEMALE
+      FEMALE = 'Female'.freeze,
+
+      # TODO: Write general description for MALE
+      MALE = 'Male'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      APPOINTMENT_GENDER_PREFERENCE1_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 'female' then FEMALE
+      when 'male' then MALE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/appointment_gender_preference_enum.rb

@@ -0,0 +1,44 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The gender of staff member with whom the client prefers to book
+  # appointments.  Possible values are: * Female - Indicates that the client
+  # prefers to book appointments with female staff members. * Male - Indicates
+  # that the client prefers to book appointments with male staff members. * None
+  # - Indicates that the client does not have a staff member gender preference.
+  class AppointmentGenderPreferenceEnum
+    APPOINTMENT_GENDER_PREFERENCE_ENUM = [
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for FEMALE
+      FEMALE = 'Female'.freeze,
+
+      # TODO: Write general description for MALE
+      MALE = 'Male'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      APPOINTMENT_GENDER_PREFERENCE_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 'female' then FEMALE
+      when 'male' then MALE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/appointment_option.rb

@@ -0,0 +1,91 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # An appointment option name/value pair
+  class AppointmentOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name displayed for this appointment option.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The name given to this option.
+    # @return [String]
+    attr_accessor :name
+
+    # The value of the option.
+    # @return [String]
+    attr_accessor :value
+
+    # The data type of the option value.
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'DisplayName'
+      @_hash['name'] = 'Name'
+      @_hash['value'] = 'Value'
+      @_hash['type'] = 'Type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        name
+        value
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name = SKIP, name = SKIP, value = SKIP, type = SKIP)
+      @display_name = display_name unless display_name == SKIP
+      @name = name unless name == SKIP
+      @value = value unless value == SKIP
+      @type = type unless type == 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.
+      display_name = hash.key?('DisplayName') ? hash['DisplayName'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      value = hash.key?('Value') ? hash['Value'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+
+      # Create object from extracted values.
+      AppointmentOption.new(display_name,
+                            name,
+                            value,
+                            type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name}, name: #{@name}, value: #{@value}, type:"\
+      " #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name.inspect}, name: #{@name.inspect}, value:"\
+      " #{@value.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/appointment_staff.rb

@@ -0,0 +1,92 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AppointmentStaff Model.
+  class AppointmentStaff < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :display_name
+
+    # 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['display_name'] = 'DisplayName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        first_name
+        last_name
+        display_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, first_name = SKIP, last_name = SKIP,
+                   display_name = SKIP)
+      @id = id unless id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @display_name = display_name unless display_name == 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
+      display_name = hash.key?('DisplayName') ? hash['DisplayName'] : SKIP
+
+      # Create object from extracted values.
+      AppointmentStaff.new(id,
+                           first_name,
+                           last_name,
+                           display_name)
+    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},"\
+      " display_name: #{@display_name}>"
+    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}, display_name: #{@display_name.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/appointment_status_enum.rb

@@ -0,0 +1,64 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The status of the appointment.
+  class AppointmentStatusEnum
+    APPOINTMENT_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?
+
+      APPOINTMENT_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/assign_staff_session_type_request.rb

@@ -0,0 +1,146 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AssignStaffSessionTypeRequest Model.
+  class AssignStaffSessionTypeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the staff member session type is getting assigned to. The staff
+    # member must be assignable to appointments or already be assigned to the
+    # session type in the request.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The ID of the session type that is getting assigned to the staff member.
+    # The session type must be an appointment.
+    # @return [Integer]
+    attr_accessor :session_type_id
+
+    # Indicates if assignment is active. Passing `false` is equivalent to
+    # deleting the assignment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # The staff specific amount of time that a session of this type typically
+    # lasts.
+    # @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. Can be one of the following (case insensitive):
+    #    Percent
+    #    Flat
+    #    No Pay
+    #    If PayRateType is not provided in the request and the request is
+    # creating a completely new assignment (not editing an existing active or
+    # inactive assignment), then the staff member default pay rate and pay rate
+    # amount are used to create the assignment. Otherwise, the existing
+    # assignment values are used for any optional request parameters not
+    # included in the request.
+    # @return [String]
+    attr_accessor :pay_rate_type
+
+    # The pay rate amount for the specific staff member. It is parsed according
+    # to the PayRateType.
+    # @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['session_type_id'] = 'SessionTypeId'
+      @_hash['active'] = 'Active'
+      @_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[
+        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 = nil, session_type_id = nil, active = nil,
+                   time_length = SKIP, prep_time = SKIP, finish_time = SKIP,
+                   pay_rate_type = SKIP, pay_rate_amount = SKIP)
+      @staff_id = staff_id
+      @session_type_id = session_type_id
+      @active = active
+      @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'] : nil
+      session_type_id = hash.key?('SessionTypeId') ? hash['SessionTypeId'] : nil
+      active = hash.key?('Active') ? hash['Active'] : nil
+      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.
+      AssignStaffSessionTypeRequest.new(staff_id,
+                                        session_type_id,
+                                        active,
+                                        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}, session_type_id: #{@session_type_id}, active:"\
+      " #{@active}, 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}, session_type_id:"\
+      " #{@session_type_id.inspect}, active: #{@active.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