mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/add_appointment_request.rb

@@ -0,0 +1,319 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Represents a request to add a new appointment, including details such as
+  # client information, appointment timing, location, and additional
+  # preferences.
+  class AddAppointmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, indicates that a payment should be applied to the
+    # appointment. 
+    # <br />Default: **true**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :apply_payment
+
+    # The RRSID of the client for whom the new appointment is being made.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The duration of the appointment. This parameter is used to change the
+    # default duration of an appointment.
+    # @return [Integer]
+    attr_accessor :duration
+
+    # The action taken to add this appointment. Possible values are: confirm,
+    # unconfirm, arrive, unarrive, cancel, latecancel, complete.
+    # @return [String]
+    attr_accessor :execute
+
+    # The end date and time of the new appointment. <br />
+    # Default: **StartDateTime**, offset by the staff member’s default
+    # appointment duration.
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # The client’s service provider gender preference.
+    # @return [String]
+    attr_accessor :gender_preference
+
+    # The ID of the location where the new appointment is to take place.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Any general notes about this appointment.
+    # @return [String]
+    attr_accessor :notes
+
+    # If a user has Complementary and Alternative Medicine features enabled,
+    # this parameter assigns a provider ID to the appointment.
+    # @return [String]
+    attr_accessor :provider_id
+
+    # A list of resource IDs to associate with the new appointment.
+    # @return [Array[Integer]]
+    attr_accessor :resource_ids
+
+    # Whether to send client an email for cancellations. An email is sent only
+    # if the client has an email address and automatic emails have been set up. 
+    # <br />Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email
+
+    # The session type associated with the new appointment.
+    # @return [Integer]
+    attr_accessor :session_type_id
+
+    # The ID of the staff member who is adding the new appointment.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # When `true`, indicates that the staff member was requested specifically by
+    # the client.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :staff_requested
+
+    # The start date and time of the new appointment.
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # When true, indicates that the method is to be validated, but no new
+    # appointment data is added. 
+    # <br />Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # When `true`, indicates that the client should be added to a specific
+    # appointment waiting list.
+    # When `false`, the client should not be added to the waiting list.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_waitlist
+
+    # Indicates whether to add an appointment request for review.
+    # If `true`, the appointment will be added as a request, bypassing the
+    # `IsWaitlist` parameter and two validations:
+    # 1. If a consumer is adding the appointment for another person.
+    # 2. If a staff member without permission to add appointments for other
+    # staff members is adding the appointment for another staff member.
+    # This also allows anonymous calls (without an authentication token) to this
+    # endpoint.
+    # The `AllowClientsToBookAppointments` option must be disabled. If it is
+    # enabled and the `IsRequest` parameter is `true`, it will return an error.
+    # For the appointment to be created as a request, one of the following
+    # conditions must also be met:
+    # - The call is anonymous (no authentication token provided).
+    # - The call is authenticated with a consumer token.
+    # - The authenticated user lacks permission to book appointments for other
+    # staff (`BookAppointmentsForAllStaff`) and is attempting to book for a
+    # different staff member.
+    #   - In this last case, if the `IsRequest` parameter is `true` and the
+    # authenticated user has the `BookAppointmentsForAllStaff` permission or is
+    # attempting to book the appointment for themselves,
+    #   the appointment will be created, but not as an appointment request.
+    # If `false`, the appointment will follow the standard creation process,
+    # respecting the `IsWaitlist` parameter.
+    # Default: `false`
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_request
+
+    # Optional external key for api partners.
+    # @return [String]
+    attr_accessor :partner_external_id
+
+    # A unique identifier for tracking the AddAppointmentRequest. This ID is not
+    # stored and is used to match each request with its corresponding response.
+    # The request object will also be returned in the response, with the same ID
+    # value.
+    # - For single requests, this value will be ignored.
+    # - For multiple requests, if no value is provided, the system will generate
+    # an identifier ranging from 0 to (number of requests - 1).
+    # @return [Integer]
+    attr_accessor :add_appointment_request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['apply_payment'] = 'ApplyPayment'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['duration'] = 'Duration'
+      @_hash['execute'] = 'Execute'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['gender_preference'] = 'GenderPreference'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['notes'] = 'Notes'
+      @_hash['provider_id'] = 'ProviderId'
+      @_hash['resource_ids'] = 'ResourceIds'
+      @_hash['send_email'] = 'SendEmail'
+      @_hash['session_type_id'] = 'SessionTypeId'
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['staff_requested'] = 'StaffRequested'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['test'] = 'Test'
+      @_hash['is_waitlist'] = 'IsWaitlist'
+      @_hash['is_request'] = 'IsRequest'
+      @_hash['partner_external_id'] = 'PartnerExternalId'
+      @_hash['add_appointment_request_id'] = 'AddAppointmentRequestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        apply_payment
+        duration
+        execute
+        end_date_time
+        gender_preference
+        notes
+        provider_id
+        resource_ids
+        send_email
+        staff_requested
+        test
+        is_waitlist
+        is_request
+        partner_external_id
+        add_appointment_request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, location_id = nil, session_type_id = nil,
+                   staff_id = nil, start_date_time = nil, apply_payment = SKIP,
+                   duration = SKIP, execute = SKIP, end_date_time = SKIP,
+                   gender_preference = SKIP, notes = SKIP, provider_id = SKIP,
+                   resource_ids = SKIP, send_email = SKIP,
+                   staff_requested = SKIP, test = SKIP, is_waitlist = SKIP,
+                   is_request = SKIP, partner_external_id = SKIP,
+                   add_appointment_request_id = SKIP)
+      @apply_payment = apply_payment unless apply_payment == SKIP
+      @client_id = client_id
+      @duration = duration unless duration == SKIP
+      @execute = execute unless execute == SKIP
+      @end_date_time = end_date_time unless end_date_time == SKIP
+      @gender_preference = gender_preference unless gender_preference == SKIP
+      @location_id = location_id
+      @notes = notes unless notes == SKIP
+      @provider_id = provider_id unless provider_id == SKIP
+      @resource_ids = resource_ids unless resource_ids == SKIP
+      @send_email = send_email unless send_email == SKIP
+      @session_type_id = session_type_id
+      @staff_id = staff_id
+      @staff_requested = staff_requested unless staff_requested == SKIP
+      @start_date_time = start_date_time
+      @test = test unless test == SKIP
+      @is_waitlist = is_waitlist unless is_waitlist == SKIP
+      @is_request = is_request unless is_request == SKIP
+      @partner_external_id = partner_external_id unless partner_external_id == SKIP
+      unless add_appointment_request_id == SKIP
+        @add_appointment_request_id =
+          add_appointment_request_id
+      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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : nil
+      session_type_id = hash.key?('SessionTypeId') ? hash['SessionTypeId'] : nil
+      staff_id = hash.key?('StaffId') ? hash['StaffId'] : nil
+      start_date_time = if hash.key?('StartDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['StartDateTime']) if hash['StartDateTime'])
+                        end
+      apply_payment = hash.key?('ApplyPayment') ? hash['ApplyPayment'] : SKIP
+      duration = hash.key?('Duration') ? hash['Duration'] : SKIP
+      execute = hash.key?('Execute') ? hash['Execute'] : SKIP
+      end_date_time = if hash.key?('EndDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['EndDateTime']) if hash['EndDateTime'])
+                      else
+                        SKIP
+                      end
+      gender_preference =
+        hash.key?('GenderPreference') ? hash['GenderPreference'] : SKIP
+      notes = hash.key?('Notes') ? hash['Notes'] : SKIP
+      provider_id = hash.key?('ProviderId') ? hash['ProviderId'] : SKIP
+      resource_ids = hash.key?('ResourceIds') ? hash['ResourceIds'] : SKIP
+      send_email = hash.key?('SendEmail') ? hash['SendEmail'] : SKIP
+      staff_requested =
+        hash.key?('StaffRequested') ? hash['StaffRequested'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      is_waitlist = hash.key?('IsWaitlist') ? hash['IsWaitlist'] : SKIP
+      is_request = hash.key?('IsRequest') ? hash['IsRequest'] : SKIP
+      partner_external_id =
+        hash.key?('PartnerExternalId') ? hash['PartnerExternalId'] : SKIP
+      add_appointment_request_id =
+        hash.key?('AddAppointmentRequestId') ? hash['AddAppointmentRequestId'] : SKIP
+
+      # Create object from extracted values.
+      AddAppointmentRequest.new(client_id,
+                                location_id,
+                                session_type_id,
+                                staff_id,
+                                start_date_time,
+                                apply_payment,
+                                duration,
+                                execute,
+                                end_date_time,
+                                gender_preference,
+                                notes,
+                                provider_id,
+                                resource_ids,
+                                send_email,
+                                staff_requested,
+                                test,
+                                is_waitlist,
+                                is_request,
+                                partner_external_id,
+                                add_appointment_request_id)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_date_time)
+    end
+
+    def to_custom_start_date_time
+      DateTimeHelper.to_rfc3339(start_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} apply_payment: #{@apply_payment}, client_id: #{@client_id}, duration:"\
+      " #{@duration}, execute: #{@execute}, end_date_time: #{@end_date_time}, gender_preference:"\
+      " #{@gender_preference}, location_id: #{@location_id}, notes: #{@notes}, provider_id:"\
+      " #{@provider_id}, resource_ids: #{@resource_ids}, send_email: #{@send_email},"\
+      " session_type_id: #{@session_type_id}, staff_id: #{@staff_id}, staff_requested:"\
+      " #{@staff_requested}, start_date_time: #{@start_date_time}, test: #{@test}, is_waitlist:"\
+      " #{@is_waitlist}, is_request: #{@is_request}, partner_external_id: #{@partner_external_id},"\
+      " add_appointment_request_id: #{@add_appointment_request_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} apply_payment: #{@apply_payment.inspect}, client_id: #{@client_id.inspect},"\
+      " duration: #{@duration.inspect}, execute: #{@execute.inspect}, end_date_time:"\
+      " #{@end_date_time.inspect}, gender_preference: #{@gender_preference.inspect}, location_id:"\
+      " #{@location_id.inspect}, notes: #{@notes.inspect}, provider_id: #{@provider_id.inspect},"\
+      " resource_ids: #{@resource_ids.inspect}, send_email: #{@send_email.inspect},"\
+      " session_type_id: #{@session_type_id.inspect}, staff_id: #{@staff_id.inspect},"\
+      " staff_requested: #{@staff_requested.inspect}, start_date_time:"\
+      " #{@start_date_time.inspect}, test: #{@test.inspect}, is_waitlist: #{@is_waitlist.inspect},"\
+      " is_request: #{@is_request.inspect}, partner_external_id: #{@partner_external_id.inspect},"\
+      " add_appointment_request_id: #{@add_appointment_request_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_appointment_response.rb

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

data/lib/mindbody_public_api/models/add_arrival_request.rb

@@ -0,0 +1,113 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # AddArrivalRequest Model.
+  class AddArrivalRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the requested client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The ID of the location for the requested arrival.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # The ID of the arrival program (service category) under which this arrival
+    # is to be logged. If this is not provided, the program ID of the first
+    # arrival pricing option found will be used.
+    # OPTIONAL: will take first payment found if not provided
+    # Default: **null**
+    # @return [Integer]
+    attr_accessor :arrival_type_id
+
+    # The ID of the Lead Channel ID from lead management. If this is supplied
+    # then it will map lead channel on the lead management.
+    # If this is not supplied then it wont save anything.
+    # This parameters required to track the lead channel if new client added
+    # while adding arrival of client on non home location.
+    # @return [Integer]
+    attr_accessor :lead_channel_id
+
+    # When `true`, indicates that the arrival log is to be validated, but no new
+    # arrival data is added. When `false`, the arrival is logged and the
+    # database is affected.
+    # Default: **false**
+    # @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['location_id'] = 'LocationId'
+      @_hash['arrival_type_id'] = 'ArrivalTypeId'
+      @_hash['lead_channel_id'] = 'LeadChannelId'
+      @_hash['test'] = 'Test'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        arrival_type_id
+        lead_channel_id
+        test
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, location_id = nil, arrival_type_id = SKIP,
+                   lead_channel_id = SKIP, test = SKIP)
+      @client_id = client_id
+      @location_id = location_id
+      @arrival_type_id = arrival_type_id unless arrival_type_id == SKIP
+      @lead_channel_id = lead_channel_id unless lead_channel_id == 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
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : nil
+      arrival_type_id =
+        hash.key?('ArrivalTypeId') ? hash['ArrivalTypeId'] : SKIP
+      lead_channel_id =
+        hash.key?('LeadChannelId') ? hash['LeadChannelId'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+
+      # Create object from extracted values.
+      AddArrivalRequest.new(client_id,
+                            location_id,
+                            arrival_type_id,
+                            lead_channel_id,
+                            test)
+    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}, location_id: #{@location_id}, arrival_type_id:"\
+      " #{@arrival_type_id}, lead_channel_id: #{@lead_channel_id}, 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}, location_id: #{@location_id.inspect},"\
+      " arrival_type_id: #{@arrival_type_id.inspect}, lead_channel_id:"\
+      " #{@lead_channel_id.inspect}, test: #{@test.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/add_arrival_response.rb

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