mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/substitute_class_teacher_response.rb

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

data/lib/mindbody_public_api/models/substitute_teacher_class.rb

@@ -0,0 +1,318 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Represents a single class instance. Used in SubstituteClassTeacher endpoint.
+  class SubstituteTeacherClass < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The class schedule ID of the requested class.
+    # @return [Integer]
+    attr_accessor :class_schedule_id
+
+    # The class schedule ID of the requested class.
+    # @return [Location]
+    attr_accessor :location
+
+    # The total number of bookings allowed in the class.
+    # @return [Integer]
+    attr_accessor :max_capacity
+
+    # The total number of online bookings allowed in the class.
+    # @return [Integer]
+    attr_accessor :web_capacity
+
+    # The total number of clients who are booked into the class prior to this
+    # call being made.
+    # @return [Integer]
+    attr_accessor :total_booked
+
+    # The total number of booked clients who are on the waiting list for the
+    # class prior to this call being made.
+    # @return [Integer]
+    attr_accessor :total_booked_waitlist
+
+    # The total number of bookings in the class made by online users, prior to
+    # this call being made. This property is the current number of bookings
+    # counted toward the `WebCapacity` limit.
+    # @return [Integer]
+    attr_accessor :web_booked
+
+    # Identifies the semester assigned to this class.
+    # @return [Integer]
+    attr_accessor :semester_id
+
+    # When `true`, indicates that the class has been canceled.<br />
+    # When `false`, indicates that the class has not been canceled and may still
+    # be bookable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_canceled
+
+    # When `true`, indicates that the class is being taught by a substitute
+    # teacher.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :substitute
+
+    # When `true`, indicates that the class is being shown to clients in
+    # consumer mode.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # When `true`, indicates that the class has a waiting list and there is
+    # space available on the waiting list for another client.<br />
+    # When `false`, indicates either that the class does not have a waiting list
+    # or there is no space available on the class waiting list.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_waitlist_available
+
+    # When `true`, indicates that this class is should not be shown to clients
+    # when `IsCancelled` is `true`.<br />
+    # When `false`, indicates that this class is should be shown to clients when
+    # `IsCancelled` is `true`.<br />
+    # This property can be ignored when the `IsCancelled` property is `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_cancel
+
+    # The unique identifier of the class.
+    # @return [Integer]
+    attr_accessor :id
+
+    # When `true`, indicates that the class can be booked.<br />
+    # When `false`, that the class cannot be booked at this time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_available
+
+    # The date and time that this class is scheduled to start.
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # The date and time when this class is scheduled to end.
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # The last time the class was modified.
+    # @return [DateTime]
+    attr_accessor :last_modified_date_time
+
+    # Represents a class definition. The class meets at the start time, goes
+    # until the end time.
+    # @return [ClassDescription]
+    attr_accessor :class_description
+
+    # The Staff
+    # @return [Staff]
+    attr_accessor :staff
+
+    # The URL for the pre-recorded live stream for the class if hosted on the
+    # mindbody virtual wellness platform
+    # @return [String]
+    attr_accessor :virtual_stream_link
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['class_schedule_id'] = 'ClassScheduleId'
+      @_hash['location'] = 'Location'
+      @_hash['max_capacity'] = 'MaxCapacity'
+      @_hash['web_capacity'] = 'WebCapacity'
+      @_hash['total_booked'] = 'TotalBooked'
+      @_hash['total_booked_waitlist'] = 'TotalBookedWaitlist'
+      @_hash['web_booked'] = 'WebBooked'
+      @_hash['semester_id'] = 'SemesterId'
+      @_hash['is_canceled'] = 'IsCanceled'
+      @_hash['substitute'] = 'Substitute'
+      @_hash['active'] = 'Active'
+      @_hash['is_waitlist_available'] = 'IsWaitlistAvailable'
+      @_hash['hide_cancel'] = 'HideCancel'
+      @_hash['id'] = 'Id'
+      @_hash['is_available'] = 'IsAvailable'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['last_modified_date_time'] = 'LastModifiedDateTime'
+      @_hash['class_description'] = 'ClassDescription'
+      @_hash['staff'] = 'Staff'
+      @_hash['virtual_stream_link'] = 'VirtualStreamLink'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        class_schedule_id
+        location
+        max_capacity
+        web_capacity
+        total_booked
+        total_booked_waitlist
+        web_booked
+        semester_id
+        is_canceled
+        substitute
+        active
+        is_waitlist_available
+        hide_cancel
+        id
+        is_available
+        start_date_time
+        end_date_time
+        last_modified_date_time
+        class_description
+        staff
+        virtual_stream_link
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(class_schedule_id = SKIP, location = SKIP,
+                   max_capacity = SKIP, web_capacity = SKIP,
+                   total_booked = SKIP, total_booked_waitlist = SKIP,
+                   web_booked = SKIP, semester_id = SKIP, is_canceled = SKIP,
+                   substitute = SKIP, active = SKIP,
+                   is_waitlist_available = SKIP, hide_cancel = SKIP, id = SKIP,
+                   is_available = SKIP, start_date_time = SKIP,
+                   end_date_time = SKIP, last_modified_date_time = SKIP,
+                   class_description = SKIP, staff = SKIP,
+                   virtual_stream_link = SKIP)
+      @class_schedule_id = class_schedule_id unless class_schedule_id == SKIP
+      @location = location unless location == SKIP
+      @max_capacity = max_capacity unless max_capacity == SKIP
+      @web_capacity = web_capacity unless web_capacity == SKIP
+      @total_booked = total_booked unless total_booked == SKIP
+      @total_booked_waitlist = total_booked_waitlist unless total_booked_waitlist == SKIP
+      @web_booked = web_booked unless web_booked == SKIP
+      @semester_id = semester_id unless semester_id == SKIP
+      @is_canceled = is_canceled unless is_canceled == SKIP
+      @substitute = substitute unless substitute == SKIP
+      @active = active unless active == SKIP
+      @is_waitlist_available = is_waitlist_available unless is_waitlist_available == SKIP
+      @hide_cancel = hide_cancel unless hide_cancel == SKIP
+      @id = id unless id == SKIP
+      @is_available = is_available unless is_available == SKIP
+      @start_date_time = start_date_time unless start_date_time == SKIP
+      @end_date_time = end_date_time unless end_date_time == SKIP
+      @last_modified_date_time = last_modified_date_time unless last_modified_date_time == SKIP
+      @class_description = class_description unless class_description == SKIP
+      @staff = staff unless staff == SKIP
+      @virtual_stream_link = virtual_stream_link unless virtual_stream_link == 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.
+      class_schedule_id =
+        hash.key?('ClassScheduleId') ? hash['ClassScheduleId'] : SKIP
+      location = Location.from_hash(hash['Location']) if hash['Location']
+      max_capacity = hash.key?('MaxCapacity') ? hash['MaxCapacity'] : SKIP
+      web_capacity = hash.key?('WebCapacity') ? hash['WebCapacity'] : SKIP
+      total_booked = hash.key?('TotalBooked') ? hash['TotalBooked'] : SKIP
+      total_booked_waitlist =
+        hash.key?('TotalBookedWaitlist') ? hash['TotalBookedWaitlist'] : SKIP
+      web_booked = hash.key?('WebBooked') ? hash['WebBooked'] : SKIP
+      semester_id = hash.key?('SemesterId') ? hash['SemesterId'] : SKIP
+      is_canceled = hash.key?('IsCanceled') ? hash['IsCanceled'] : SKIP
+      substitute = hash.key?('Substitute') ? hash['Substitute'] : SKIP
+      active = hash.key?('Active') ? hash['Active'] : SKIP
+      is_waitlist_available =
+        hash.key?('IsWaitlistAvailable') ? hash['IsWaitlistAvailable'] : SKIP
+      hide_cancel = hash.key?('HideCancel') ? hash['HideCancel'] : SKIP
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      is_available = hash.key?('IsAvailable') ? hash['IsAvailable'] : SKIP
+      start_date_time = if hash.key?('StartDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['StartDateTime']) if hash['StartDateTime'])
+                        else
+                          SKIP
+                        end
+      end_date_time = if hash.key?('EndDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['EndDateTime']) if hash['EndDateTime'])
+                      else
+                        SKIP
+                      end
+      last_modified_date_time = if hash.key?('LastModifiedDateTime')
+                                  (DateTimeHelper.from_rfc3339(hash['LastModifiedDateTime']) if hash['LastModifiedDateTime'])
+                                else
+                                  SKIP
+                                end
+      class_description = ClassDescription.from_hash(hash['ClassDescription']) if
+        hash['ClassDescription']
+      staff = Staff.from_hash(hash['Staff']) if hash['Staff']
+      virtual_stream_link =
+        hash.key?('VirtualStreamLink') ? hash['VirtualStreamLink'] : SKIP
+
+      # Create object from extracted values.
+      SubstituteTeacherClass.new(class_schedule_id,
+                                 location,
+                                 max_capacity,
+                                 web_capacity,
+                                 total_booked,
+                                 total_booked_waitlist,
+                                 web_booked,
+                                 semester_id,
+                                 is_canceled,
+                                 substitute,
+                                 active,
+                                 is_waitlist_available,
+                                 hide_cancel,
+                                 id,
+                                 is_available,
+                                 start_date_time,
+                                 end_date_time,
+                                 last_modified_date_time,
+                                 class_description,
+                                 staff,
+                                 virtual_stream_link)
+    end
+
+    def to_custom_start_date_time
+      DateTimeHelper.to_rfc3339(start_date_time)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_date_time)
+    end
+
+    def to_custom_last_modified_date_time
+      DateTimeHelper.to_rfc3339(last_modified_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} class_schedule_id: #{@class_schedule_id}, location: #{@location},"\
+      " max_capacity: #{@max_capacity}, web_capacity: #{@web_capacity}, total_booked:"\
+      " #{@total_booked}, total_booked_waitlist: #{@total_booked_waitlist}, web_booked:"\
+      " #{@web_booked}, semester_id: #{@semester_id}, is_canceled: #{@is_canceled}, substitute:"\
+      " #{@substitute}, active: #{@active}, is_waitlist_available: #{@is_waitlist_available},"\
+      " hide_cancel: #{@hide_cancel}, id: #{@id}, is_available: #{@is_available}, start_date_time:"\
+      " #{@start_date_time}, end_date_time: #{@end_date_time}, last_modified_date_time:"\
+      " #{@last_modified_date_time}, class_description: #{@class_description}, staff: #{@staff},"\
+      " virtual_stream_link: #{@virtual_stream_link}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} class_schedule_id: #{@class_schedule_id.inspect}, location:"\
+      " #{@location.inspect}, max_capacity: #{@max_capacity.inspect}, web_capacity:"\
+      " #{@web_capacity.inspect}, total_booked: #{@total_booked.inspect}, total_booked_waitlist:"\
+      " #{@total_booked_waitlist.inspect}, web_booked: #{@web_booked.inspect}, semester_id:"\
+      " #{@semester_id.inspect}, is_canceled: #{@is_canceled.inspect}, substitute:"\
+      " #{@substitute.inspect}, active: #{@active.inspect}, is_waitlist_available:"\
+      " #{@is_waitlist_available.inspect}, hide_cancel: #{@hide_cancel.inspect}, id:"\
+      " #{@id.inspect}, is_available: #{@is_available.inspect}, start_date_time:"\
+      " #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect},"\
+      " last_modified_date_time: #{@last_modified_date_time.inspect}, class_description:"\
+      " #{@class_description.inspect}, staff: #{@staff.inspect}, virtual_stream_link:"\
+      " #{@virtual_stream_link.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/suspend_contract_request.rb

@@ -0,0 +1,162 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # SuspendContractRequest Model.
+  class SuspendContractRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The unique ID of the sale of the contract.
+    # @return [Integer]
+    attr_accessor :client_contract_id
+
+    # ex. Illness, Injury, Vacation. (Note this can be customized by each
+    # studio).
+    # If provided, then Duration, DurationUnit, and SuspensionFee (if
+    # applicable) are automatically applied. Restrict Days are not supported.
+    # @return [String]
+    attr_accessor :suspension_type
+
+    # The contract suspension start date.
+    # Default: *today’s date*
+    # @return [DateTime]
+    attr_accessor :suspension_start
+
+    # The number of (DurationUnit) the suspension lasts.
+    # @return [Integer]
+    attr_accessor :duration
+
+    # The unit applied to Duration.
+    # @return [Integer]
+    attr_accessor :duration_unit
+
+    # When `true`, indicates that suspension is open ended. Also, when `true`,
+    # then Duration and DurationUnit are ignored.
+    # Default: *false*
+    # @return [TrueClass | FalseClass]
+    attr_accessor :open_ended
+
+    # The comments for suspending a contract.
+    # @return [String]
+    attr_accessor :suspension_notes
+
+    # An optional charge that clients who wish to pause a contract for a set
+    # period of time can be charged.
+    # @return [Float]
+    attr_accessor :suspension_fee
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['client_contract_id'] = 'ClientContractId'
+      @_hash['suspension_type'] = 'SuspensionType'
+      @_hash['suspension_start'] = 'SuspensionStart'
+      @_hash['duration'] = 'Duration'
+      @_hash['duration_unit'] = 'DurationUnit'
+      @_hash['open_ended'] = 'OpenEnded'
+      @_hash['suspension_notes'] = 'SuspensionNotes'
+      @_hash['suspension_fee'] = 'SuspensionFee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        suspension_type
+        suspension_start
+        duration
+        duration_unit
+        open_ended
+        suspension_notes
+        suspension_fee
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, client_contract_id = nil,
+                   suspension_type = SKIP, suspension_start = SKIP,
+                   duration = SKIP, duration_unit = SKIP, open_ended = SKIP,
+                   suspension_notes = SKIP, suspension_fee = SKIP)
+      @client_id = client_id
+      @client_contract_id = client_contract_id
+      @suspension_type = suspension_type unless suspension_type == SKIP
+      @suspension_start = suspension_start unless suspension_start == SKIP
+      @duration = duration unless duration == SKIP
+      @duration_unit = duration_unit unless duration_unit == SKIP
+      @open_ended = open_ended unless open_ended == SKIP
+      @suspension_notes = suspension_notes unless suspension_notes == SKIP
+      @suspension_fee = suspension_fee unless suspension_fee == 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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      client_contract_id =
+        hash.key?('ClientContractId') ? hash['ClientContractId'] : nil
+      suspension_type =
+        hash.key?('SuspensionType') ? hash['SuspensionType'] : SKIP
+      suspension_start = if hash.key?('SuspensionStart')
+                           (DateTimeHelper.from_rfc3339(hash['SuspensionStart']) if hash['SuspensionStart'])
+                         else
+                           SKIP
+                         end
+      duration = hash.key?('Duration') ? hash['Duration'] : SKIP
+      duration_unit = hash.key?('DurationUnit') ? hash['DurationUnit'] : SKIP
+      open_ended = hash.key?('OpenEnded') ? hash['OpenEnded'] : SKIP
+      suspension_notes =
+        hash.key?('SuspensionNotes') ? hash['SuspensionNotes'] : SKIP
+      suspension_fee = hash.key?('SuspensionFee') ? hash['SuspensionFee'] : SKIP
+
+      # Create object from extracted values.
+      SuspendContractRequest.new(client_id,
+                                 client_contract_id,
+                                 suspension_type,
+                                 suspension_start,
+                                 duration,
+                                 duration_unit,
+                                 open_ended,
+                                 suspension_notes,
+                                 suspension_fee)
+    end
+
+    def to_custom_suspension_start
+      DateTimeHelper.to_rfc3339(suspension_start)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id}, client_contract_id: #{@client_contract_id},"\
+      " suspension_type: #{@suspension_type}, suspension_start: #{@suspension_start}, duration:"\
+      " #{@duration}, duration_unit: #{@duration_unit}, open_ended: #{@open_ended},"\
+      " suspension_notes: #{@suspension_notes}, suspension_fee: #{@suspension_fee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_id: #{@client_id.inspect}, client_contract_id:"\
+      " #{@client_contract_id.inspect}, suspension_type: #{@suspension_type.inspect},"\
+      " suspension_start: #{@suspension_start.inspect}, duration: #{@duration.inspect},"\
+      " duration_unit: #{@duration_unit.inspect}, open_ended: #{@open_ended.inspect},"\
+      " suspension_notes: #{@suspension_notes.inspect}, suspension_fee:"\
+      " #{@suspension_fee.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/suspend_contract_response.rb

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