mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/assign_staff_session_type_response.rb

@@ -0,0 +1,138 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AssignStaffSessionTypeResponse Model.
+  class AssignStaffSessionTypeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Staff member assigned to the session type
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The session type the staff member is assigned to
+    # @return [Integer]
+    attr_accessor :session_type_id
+
+    # The pay rate type name
+    # Can be: "Flat", "Percent", or "No Pay"
+    # @return [String]
+    attr_accessor :pay_rate_type
+
+    # The pay rate amount. It is interpreted based on the value of PayRateTypeId
+    # @return [Float]
+    attr_accessor :pay_rate_amount
+
+    # 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
+
+    # Whether this association 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['staff_id'] = 'StaffId'
+      @_hash['session_type_id'] = 'SessionTypeId'
+      @_hash['pay_rate_type'] = 'PayRateType'
+      @_hash['pay_rate_amount'] = 'PayRateAmount'
+      @_hash['time_length'] = 'TimeLength'
+      @_hash['prep_time'] = 'PrepTime'
+      @_hash['finish_time'] = 'FinishTime'
+      @_hash['active'] = 'Active'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        session_type_id
+        pay_rate_type
+        pay_rate_amount
+        time_length
+        prep_time
+        finish_time
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, session_type_id = SKIP,
+                   pay_rate_type = SKIP, pay_rate_amount = SKIP,
+                   time_length = SKIP, prep_time = SKIP, finish_time = SKIP,
+                   active = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @session_type_id = session_type_id unless session_type_id == SKIP
+      @pay_rate_type = pay_rate_type unless pay_rate_type == SKIP
+      @pay_rate_amount = pay_rate_amount unless pay_rate_amount == 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
+      @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.
+      staff_id = hash.key?('StaffId') ? hash['StaffId'] : SKIP
+      session_type_id =
+        hash.key?('SessionTypeId') ? hash['SessionTypeId'] : SKIP
+      pay_rate_type = hash.key?('PayRateType') ? hash['PayRateType'] : SKIP
+      pay_rate_amount =
+        hash.key?('PayRateAmount') ? hash['PayRateAmount'] : 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
+      active = hash.key?('Active') ? hash['Active'] : SKIP
+
+      # Create object from extracted values.
+      AssignStaffSessionTypeResponse.new(staff_id,
+                                         session_type_id,
+                                         pay_rate_type,
+                                         pay_rate_amount,
+                                         time_length,
+                                         prep_time,
+                                         finish_time,
+                                         active)
+    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},"\
+      " pay_rate_type: #{@pay_rate_type}, pay_rate_amount: #{@pay_rate_amount}, time_length:"\
+      " #{@time_length}, prep_time: #{@prep_time}, finish_time: #{@finish_time}, active:"\
+      " #{@active}>"
+    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}, pay_rate_type: #{@pay_rate_type.inspect}, pay_rate_amount:"\
+      " #{@pay_rate_amount.inspect}, time_length: #{@time_length.inspect}, prep_time:"\
+      " #{@prep_time.inspect}, finish_time: #{@finish_time.inspect}, active: #{@active.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/assigned_client_index.rb

@@ -0,0 +1,71 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Represents a client index value assigned to a client
+  class AssignedClientIndex < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The index ID assigned to the client.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The index’s value ID.
+    # @return [Integer]
+    attr_accessor :value_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['value_id'] = 'ValueId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        value_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, value_id = SKIP)
+      @id = id unless id == SKIP
+      @value_id = value_id unless value_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
+      value_id = hash.key?('ValueId') ? hash['ValueId'] : SKIP
+
+      # Create object from extracted values.
+      AssignedClientIndex.new(id,
+                              value_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}, value_id: #{@value_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}, value_id: #{@value_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/autopay_schedule.rb

@@ -0,0 +1,93 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AutopaySchedule Model.
+  class AutopaySchedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how often clients are charged. Possible values are:
+    # * SetNumberOfAutopays
+    # * MonthToMonth
+    # @return [String]
+    attr_accessor :frequency_type
+
+    # The interval of AutoPay frequency, combined with `FrequencyTimeUnit`. This
+    # value is null if `FrequencyType` is `MonthToMonth`.
+    # @return [Integer]
+    attr_accessor :frequency_value
+
+    # Defines the time unit that sets how often to run the AutoPay, combined
+    # with `FrequencyValue`. This value is null if `FrequencyType` is
+    # `MonthToMonth`. Possible values are:
+    # * Weekly
+    # * Monthly
+    # * Yearly
+    # @return [String]
+    attr_accessor :frequency_time_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['frequency_type'] = 'FrequencyType'
+      @_hash['frequency_value'] = 'FrequencyValue'
+      @_hash['frequency_time_unit'] = 'FrequencyTimeUnit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        frequency_type
+        frequency_value
+        frequency_time_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency_type = SKIP, frequency_value = SKIP,
+                   frequency_time_unit = SKIP)
+      @frequency_type = frequency_type unless frequency_type == SKIP
+      @frequency_value = frequency_value unless frequency_value == SKIP
+      @frequency_time_unit = frequency_time_unit unless frequency_time_unit == 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.
+      frequency_type = hash.key?('FrequencyType') ? hash['FrequencyType'] : SKIP
+      frequency_value =
+        hash.key?('FrequencyValue') ? hash['FrequencyValue'] : SKIP
+      frequency_time_unit =
+        hash.key?('FrequencyTimeUnit') ? hash['FrequencyTimeUnit'] : SKIP
+
+      # Create object from extracted values.
+      AutopaySchedule.new(frequency_type,
+                          frequency_value,
+                          frequency_time_unit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} frequency_type: #{@frequency_type}, frequency_value: #{@frequency_value},"\
+      " frequency_time_unit: #{@frequency_time_unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} frequency_type: #{@frequency_type.inspect}, frequency_value:"\
+      " #{@frequency_value.inspect}, frequency_time_unit: #{@frequency_time_unit.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/autopay_status_enum.rb

@@ -0,0 +1,40 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The status of the client’s autopay.
+  class AutopayStatusEnum
+    AUTOPAY_STATUS_ENUM = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'Inactive'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'Suspended'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTOPAY_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      when 'suspended' then SUSPENDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mindbody_public_api/models/availability.rb

@@ -0,0 +1,233 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # A staff availability entry
+  class Availability < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the availability.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The Staff
+    # @return [Staff]
+    attr_accessor :staff
+
+    # SessionType contains information about the session types in a business.
+    # @return [SessionType]
+    attr_accessor :session_type
+
+    # Contains information about the programs.
+    # @return [Array[Program]]
+    attr_accessor :programs
+
+    # The date and time the availability starts.
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # The date and time the availability ends.
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # The time of day that the last appointment can start.
+    # @return [DateTime]
+    attr_accessor :bookable_end_date_time
+
+    # The time of day that the last appointment can start.
+    # @return [Location]
+    attr_accessor :location
+
+    # Prep time in minutes
+    # @return [Integer]
+    attr_accessor :prep_time
+
+    # Finish time in minutes
+    # @return [Integer]
+    attr_accessor :finish_time
+
+    # When `true`, indicates that the staff member's name for availabilty is
+    # masked.
+    # When `false`, indicates that the staff member's name for availabilty is
+    # not masked.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_masked
+
+    # When `true`, indicates that the schedule is shown to the clients.
+    # When `false`, indicates that the schedule is hidden from the clients.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_public
+
+    # Contains information about resources availability for the specified
+    # session type.
+    # @return [Array[ResourceAvailability]]
+    attr_accessor :resource_availabilities
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['staff'] = 'Staff'
+      @_hash['session_type'] = 'SessionType'
+      @_hash['programs'] = 'Programs'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['bookable_end_date_time'] = 'BookableEndDateTime'
+      @_hash['location'] = 'Location'
+      @_hash['prep_time'] = 'PrepTime'
+      @_hash['finish_time'] = 'FinishTime'
+      @_hash['is_masked'] = 'IsMasked'
+      @_hash['show_public'] = 'ShowPublic'
+      @_hash['resource_availabilities'] = 'ResourceAvailabilities'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        staff
+        session_type
+        programs
+        start_date_time
+        end_date_time
+        bookable_end_date_time
+        location
+        prep_time
+        finish_time
+        is_masked
+        show_public
+        resource_availabilities
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, staff = SKIP, session_type = SKIP,
+                   programs = SKIP, start_date_time = SKIP,
+                   end_date_time = SKIP, bookable_end_date_time = SKIP,
+                   location = SKIP, prep_time = SKIP, finish_time = SKIP,
+                   is_masked = SKIP, show_public = SKIP,
+                   resource_availabilities = SKIP)
+      @id = id unless id == SKIP
+      @staff = staff unless staff == SKIP
+      @session_type = session_type unless session_type == SKIP
+      @programs = programs unless programs == SKIP
+      @start_date_time = start_date_time unless start_date_time == SKIP
+      @end_date_time = end_date_time unless end_date_time == SKIP
+      @bookable_end_date_time = bookable_end_date_time unless bookable_end_date_time == SKIP
+      @location = location unless location == SKIP
+      @prep_time = prep_time unless prep_time == SKIP
+      @finish_time = finish_time unless finish_time == SKIP
+      @is_masked = is_masked unless is_masked == SKIP
+      @show_public = show_public unless show_public == SKIP
+      @resource_availabilities = resource_availabilities unless resource_availabilities == 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
+      staff = Staff.from_hash(hash['Staff']) if hash['Staff']
+      session_type = SessionType.from_hash(hash['SessionType']) if hash['SessionType']
+      # Parameter is an array, so we need to iterate through it
+      programs = nil
+      unless hash['Programs'].nil?
+        programs = []
+        hash['Programs'].each do |structure|
+          programs << (Program.from_hash(structure) if structure)
+        end
+      end
+
+      programs = SKIP unless hash.key?('Programs')
+      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
+      bookable_end_date_time = if hash.key?('BookableEndDateTime')
+                                 (DateTimeHelper.from_rfc3339(hash['BookableEndDateTime']) if hash['BookableEndDateTime'])
+                               else
+                                 SKIP
+                               end
+      location = Location.from_hash(hash['Location']) if hash['Location']
+      prep_time = hash.key?('PrepTime') ? hash['PrepTime'] : SKIP
+      finish_time = hash.key?('FinishTime') ? hash['FinishTime'] : SKIP
+      is_masked = hash.key?('IsMasked') ? hash['IsMasked'] : SKIP
+      show_public = hash.key?('ShowPublic') ? hash['ShowPublic'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      resource_availabilities = nil
+      unless hash['ResourceAvailabilities'].nil?
+        resource_availabilities = []
+        hash['ResourceAvailabilities'].each do |structure|
+          resource_availabilities << (ResourceAvailability.from_hash(structure) if structure)
+        end
+      end
+
+      resource_availabilities = SKIP unless hash.key?('ResourceAvailabilities')
+
+      # Create object from extracted values.
+      Availability.new(id,
+                       staff,
+                       session_type,
+                       programs,
+                       start_date_time,
+                       end_date_time,
+                       bookable_end_date_time,
+                       location,
+                       prep_time,
+                       finish_time,
+                       is_masked,
+                       show_public,
+                       resource_availabilities)
+    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_bookable_end_date_time
+      DateTimeHelper.to_rfc3339(bookable_end_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}, staff: #{@staff}, session_type: #{@session_type}, programs:"\
+      " #{@programs}, start_date_time: #{@start_date_time}, end_date_time: #{@end_date_time},"\
+      " bookable_end_date_time: #{@bookable_end_date_time}, location: #{@location}, prep_time:"\
+      " #{@prep_time}, finish_time: #{@finish_time}, is_masked: #{@is_masked}, show_public:"\
+      " #{@show_public}, resource_availabilities: #{@resource_availabilities}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, staff: #{@staff.inspect}, session_type:"\
+      " #{@session_type.inspect}, programs: #{@programs.inspect}, start_date_time:"\
+      " #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect},"\
+      " bookable_end_date_time: #{@bookable_end_date_time.inspect}, location:"\
+      " #{@location.inspect}, prep_time: #{@prep_time.inspect}, finish_time:"\
+      " #{@finish_time.inspect}, is_masked: #{@is_masked.inspect}, show_public:"\
+      " #{@show_public.inspect}, resource_availabilities: #{@resource_availabilities.inspect}>"
+    end
+  end
+end