mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/add_client_to_enrollment_request.rb

@@ -0,0 +1,165 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Add Client To Enrollment Request Model
+  class AddClientToEnrollmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The client IDs of the clients to add to the specified enrollments.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The class schedule IDs of the enrollments to add the clients to. The
+    # ClassScheduleId can be found in GetEnrollments as the EnrollmentId.
+    # @return [Integer]
+    attr_accessor :class_schedule_id
+
+    # Enroll the clients from this date forward. `EnrollDateForward` takes
+    # priority over open enrollment.
+    # Default: **null**
+    # @return [DateTime]
+    attr_accessor :enroll_date_forward
+
+    # Enroll for selected dates.
+    # @return [Array[DateTime]]
+    attr_accessor :enroll_open
+
+    # When `true`, input information is validated, but not committed.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # When `true`, indicates that the client should be sent an email. An email
+    # is only sent if the client has an email address and automatic emails have
+    # been set up. <br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email
+
+    # When `true`, the client is added to a specific enrollments waiting list.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :waitlist
+
+    # The waiting list entry to add. Used to add a client to an enrollment from
+    # a waiting list entry.
+    # @return [Integer]
+    attr_accessor :waitlist_entry_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['class_schedule_id'] = 'ClassScheduleId'
+      @_hash['enroll_date_forward'] = 'EnrollDateForward'
+      @_hash['enroll_open'] = 'EnrollOpen'
+      @_hash['test'] = 'Test'
+      @_hash['send_email'] = 'SendEmail'
+      @_hash['waitlist'] = 'Waitlist'
+      @_hash['waitlist_entry_id'] = 'WaitlistEntryId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enroll_date_forward
+        enroll_open
+        test
+        send_email
+        waitlist
+        waitlist_entry_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, class_schedule_id = nil,
+                   enroll_date_forward = SKIP, enroll_open = SKIP, test = SKIP,
+                   send_email = SKIP, waitlist = SKIP, waitlist_entry_id = SKIP)
+      @client_id = client_id
+      @class_schedule_id = class_schedule_id
+      @enroll_date_forward = enroll_date_forward unless enroll_date_forward == SKIP
+      @enroll_open = enroll_open unless enroll_open == SKIP
+      @test = test unless test == SKIP
+      @send_email = send_email unless send_email == SKIP
+      @waitlist = waitlist unless waitlist == SKIP
+      @waitlist_entry_id = waitlist_entry_id unless waitlist_entry_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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      class_schedule_id =
+        hash.key?('ClassScheduleId') ? hash['ClassScheduleId'] : nil
+      enroll_date_forward = if hash.key?('EnrollDateForward')
+                              (DateTimeHelper.from_rfc3339(hash['EnrollDateForward']) if hash['EnrollDateForward'])
+                            else
+                              SKIP
+                            end
+      # Parameter is an array, so we need to iterate through it
+      enroll_open = nil
+      unless hash['EnrollOpen'].nil?
+        enroll_open = []
+        hash['EnrollOpen'].each do |datetime_string|
+          enroll_open << (DateTimeHelper.from_rfc3339(datetime_string) if datetime_string)
+        end
+      end
+
+      enroll_open = SKIP unless hash.key?('EnrollOpen')
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      send_email = hash.key?('SendEmail') ? hash['SendEmail'] : SKIP
+      waitlist = hash.key?('Waitlist') ? hash['Waitlist'] : SKIP
+      waitlist_entry_id =
+        hash.key?('WaitlistEntryId') ? hash['WaitlistEntryId'] : SKIP
+
+      # Create object from extracted values.
+      AddClientToEnrollmentRequest.new(client_id,
+                                       class_schedule_id,
+                                       enroll_date_forward,
+                                       enroll_open,
+                                       test,
+                                       send_email,
+                                       waitlist,
+                                       waitlist_entry_id)
+    end
+
+    def to_custom_enroll_date_forward
+      DateTimeHelper.to_rfc3339(enroll_date_forward)
+    end
+
+    def to_custom_enroll_open(hash, key)
+      DateTimeHelper.to_rfc3339_array(enroll_open, hash, key)
+    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}, class_schedule_id: #{@class_schedule_id},"\
+      " enroll_date_forward: #{@enroll_date_forward}, enroll_open: #{@enroll_open}, test:"\
+      " #{@test}, send_email: #{@send_email}, waitlist: #{@waitlist}, waitlist_entry_id:"\
+      " #{@waitlist_entry_id}>"
+    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}, class_schedule_id:"\
+      " #{@class_schedule_id.inspect}, enroll_date_forward: #{@enroll_date_forward.inspect},"\
+      " enroll_open: #{@enroll_open.inspect}, test: #{@test.inspect}, send_email:"\
+      " #{@send_email.inspect}, waitlist: #{@waitlist.inspect}, waitlist_entry_id:"\
+      " #{@waitlist_entry_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_contact_log_request.rb

@@ -0,0 +1,175 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # AddContactLogRequest Model.
+  class AddContactLogRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client whose contact log is being added.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The ID of the staff member to whom the contact log is assigned.
+    # @return [Integer]
+    attr_accessor :assigned_to_staff_id
+
+    # The body of the contact log.
+    # @return [String]
+    attr_accessor :text
+
+    # The date by which the assigned staff member should complete this contact
+    # log.
+    # @return [DateTime]
+    attr_accessor :followup_by_date
+
+    # How the client wants to be contacted.
+    # @return [String]
+    attr_accessor :contact_method
+
+    # The name of the person to be contacted by the assigned staff member.
+    # @return [String]
+    attr_accessor :contact_name
+
+    # When `true`, indicates that the contact log is complete.
+    # When `false`, indicates the contact log isn’t complete.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_complete
+
+    # Any comments on the contact log.
+    # @return [Array[String]]
+    attr_accessor :comments
+
+    # The contact log types used to tag this contact log.
+    # @return [Array[AddContactLogType]]
+    attr_accessor :types
+
+    # When `true`, indicates that this is a test request and no data is inserted
+    # into the subscriber’s database.<br />
+    # When `false`, the database is updated.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['assigned_to_staff_id'] = 'AssignedToStaffId'
+      @_hash['text'] = 'Text'
+      @_hash['followup_by_date'] = 'FollowupByDate'
+      @_hash['contact_method'] = 'ContactMethod'
+      @_hash['contact_name'] = 'ContactName'
+      @_hash['is_complete'] = 'IsComplete'
+      @_hash['comments'] = 'Comments'
+      @_hash['types'] = 'Types'
+      @_hash['test'] = 'Test'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assigned_to_staff_id
+        text
+        followup_by_date
+        contact_name
+        is_complete
+        comments
+        types
+        test
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, contact_method = nil,
+                   assigned_to_staff_id = SKIP, text = SKIP,
+                   followup_by_date = SKIP, contact_name = SKIP,
+                   is_complete = SKIP, comments = SKIP, types = SKIP,
+                   test = SKIP)
+      @client_id = client_id
+      @assigned_to_staff_id = assigned_to_staff_id unless assigned_to_staff_id == SKIP
+      @text = text unless text == SKIP
+      @followup_by_date = followup_by_date unless followup_by_date == SKIP
+      @contact_method = contact_method
+      @contact_name = contact_name unless contact_name == SKIP
+      @is_complete = is_complete unless is_complete == SKIP
+      @comments = comments unless comments == SKIP
+      @types = types unless types == SKIP
+      @test = test unless test == 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
+      contact_method = hash.key?('ContactMethod') ? hash['ContactMethod'] : nil
+      assigned_to_staff_id =
+        hash.key?('AssignedToStaffId') ? hash['AssignedToStaffId'] : SKIP
+      text = hash.key?('Text') ? hash['Text'] : SKIP
+      followup_by_date = if hash.key?('FollowupByDate')
+                           (DateTimeHelper.from_rfc3339(hash['FollowupByDate']) if hash['FollowupByDate'])
+                         else
+                           SKIP
+                         end
+      contact_name = hash.key?('ContactName') ? hash['ContactName'] : SKIP
+      is_complete = hash.key?('IsComplete') ? hash['IsComplete'] : SKIP
+      comments = hash.key?('Comments') ? hash['Comments'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      types = nil
+      unless hash['Types'].nil?
+        types = []
+        hash['Types'].each do |structure|
+          types << (AddContactLogType.from_hash(structure) if structure)
+        end
+      end
+
+      types = SKIP unless hash.key?('Types')
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+
+      # Create object from extracted values.
+      AddContactLogRequest.new(client_id,
+                               contact_method,
+                               assigned_to_staff_id,
+                               text,
+                               followup_by_date,
+                               contact_name,
+                               is_complete,
+                               comments,
+                               types,
+                               test)
+    end
+
+    def to_custom_followup_by_date
+      DateTimeHelper.to_rfc3339(followup_by_date)
+    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}, assigned_to_staff_id: #{@assigned_to_staff_id},"\
+      " text: #{@text}, followup_by_date: #{@followup_by_date}, contact_method:"\
+      " #{@contact_method}, contact_name: #{@contact_name}, is_complete: #{@is_complete},"\
+      " comments: #{@comments}, types: #{@types}, test: #{@test}>"
+    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}, assigned_to_staff_id:"\
+      " #{@assigned_to_staff_id.inspect}, text: #{@text.inspect}, followup_by_date:"\
+      " #{@followup_by_date.inspect}, contact_method: #{@contact_method.inspect}, contact_name:"\
+      " #{@contact_name.inspect}, is_complete: #{@is_complete.inspect}, comments:"\
+      " #{@comments.inspect}, types: #{@types.inspect}, test: #{@test.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_contact_log_type.rb

@@ -0,0 +1,71 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Defines what sort of subtypes we want to add to this contact log type
+  class AddContactLogType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The contact log type’s ID.
+    # @return [Integer]
+    attr_accessor :id
+
+    # A list of the subtype IDs used to tag this contact log type.
+    # @return [Array[Integer]]
+    attr_accessor :sub_types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['sub_types'] = 'SubTypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        sub_types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, sub_types = SKIP)
+      @id = id unless id == SKIP
+      @sub_types = sub_types unless sub_types == 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_types = hash.key?('SubTypes') ? hash['SubTypes'] : SKIP
+
+      # Create object from extracted values.
+      AddContactLogType.new(id,
+                            sub_types)
+    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_types: #{@sub_types}>"
+    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_types: #{@sub_types.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_formula_note_request.rb

@@ -0,0 +1,80 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AddFormulaNoteRequest Model.
+  class AddFormulaNoteRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client who needs to have a formula note added.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The appointment ID that the formula note is related to.
+    # @return [Integer]
+    attr_accessor :appointment_id
+
+    # The new formula note text.
+    # @return [String]
+    attr_accessor :note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['appointment_id'] = 'AppointmentId'
+      @_hash['note'] = 'Note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        appointment_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, note = nil, appointment_id = SKIP)
+      @client_id = client_id
+      @appointment_id = appointment_id unless appointment_id == SKIP
+      @note = note
+    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
+      note = hash.key?('Note') ? hash['Note'] : nil
+      appointment_id = hash.key?('AppointmentId') ? hash['AppointmentId'] : SKIP
+
+      # Create object from extracted values.
+      AddFormulaNoteRequest.new(client_id,
+                                note,
+                                appointment_id)
+    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}, appointment_id: #{@appointment_id}, note:"\
+      " #{@note}>"
+    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}, appointment_id:"\
+      " #{@appointment_id.inspect}, note: #{@note.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_multiple_appointments_request.rb

@@ -0,0 +1,71 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Request to add multiple appointments.
+  class AddMultipleAppointmentsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of appointment requests to be added.
+    # @return [Array[AddAppointmentRequest]]
+    attr_accessor :add_appointment_requests
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['add_appointment_requests'] = 'AddAppointmentRequests'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        add_appointment_requests
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(add_appointment_requests = SKIP)
+      @add_appointment_requests = add_appointment_requests unless add_appointment_requests == 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.
+      # Parameter is an array, so we need to iterate through it
+      add_appointment_requests = nil
+      unless hash['AddAppointmentRequests'].nil?
+        add_appointment_requests = []
+        hash['AddAppointmentRequests'].each do |structure|
+          add_appointment_requests << (AddAppointmentRequest.from_hash(structure) if structure)
+        end
+      end
+
+      add_appointment_requests = SKIP unless hash.key?('AddAppointmentRequests')
+
+      # Create object from extracted values.
+      AddMultipleAppointmentsRequest.new(add_appointment_requests)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_appointment_requests: #{@add_appointment_requests}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_appointment_requests: #{@add_appointment_requests.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_multiple_appointments_response.rb

@@ -0,0 +1,71 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Represents the response for adding multiple appointments.
+  class AddMultipleAppointmentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the created appointments.
+    # @return [Array[AddAppointmentOutcome]]
+    attr_accessor :add_appointment_outcomes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['add_appointment_outcomes'] = 'AddAppointmentOutcomes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        add_appointment_outcomes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(add_appointment_outcomes = SKIP)
+      @add_appointment_outcomes = add_appointment_outcomes unless add_appointment_outcomes == 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.
+      # Parameter is an array, so we need to iterate through it
+      add_appointment_outcomes = nil
+      unless hash['AddAppointmentOutcomes'].nil?
+        add_appointment_outcomes = []
+        hash['AddAppointmentOutcomes'].each do |structure|
+          add_appointment_outcomes << (AddAppointmentOutcome.from_hash(structure) if structure)
+        end
+      end
+
+      add_appointment_outcomes = SKIP unless hash.key?('AddAppointmentOutcomes')
+
+      # Create object from extracted values.
+      AddMultipleAppointmentsResponse.new(add_appointment_outcomes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_appointment_outcomes: #{@add_appointment_outcomes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_appointment_outcomes: #{@add_appointment_outcomes.inspect}>"
+    end
+  end
+end