mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/update_client_response.rb

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

data/lib/mindbody_public_api/models/update_client_rewards_request.rb

@@ -0,0 +1,143 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Request object for using the API to Earn or Redeem reward points
+  class UpdateClientRewardsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client that is getting rewards earned or redeemed.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The amount of points the client is getting earned or redeemed, must be a
+    # positive number.
+    # @return [Integer]
+    attr_accessor :points
+
+    # If Action passed as **Earned**,
+    # possible values are:
+    # * Appointment Booking
+    # * Class Booking
+    # * Referral
+    # * Sale
+    # <br />Omit if Action passed as **Redeemed**.
+    # @return [String]
+    attr_accessor :source
+
+    # The unique identifier in the MINDBODY system for the **Source**. If Action
+    # is **Earned**, and an optional SourceID is provided, it is validated as
+    # follows: 
+    # * If Source is Appointment Booking, then a provided SourceID must be a
+    # valid Visit.AppointmentId for the indicated Client.
+    # * If Source is **Class Booking**, then a provided SourceID must be a valid
+    # Visit.Id for the indicated client.
+    # * If Source is **Sale**, then a provided SourceID must be a valid Sale.Id
+    # for the indicated client. 
+    # * If Source is **Referral**, then a provided SourceID must be a valid
+    # Client.Id (RelatedClientId) and have been referred by the indicated client
+    # (ClientRelationship.Id = -1).
+    # If Action is **Redeemed**, and an optional SourceID is provided, then
+    # SourceID must be a valid Sale.Id for the indicated client, and refers to
+    # the sale where the indicated points were redeemed.
+    # @return [Integer]
+    attr_accessor :source_id
+
+    # Indicates if rewards are getting earned or redeemed. 
+    # Possible values are:
+    # *Earned
+    # *Redeemed
+    # @return [String]
+    attr_accessor :action
+
+    # The date and time when the points were earned or redeemed in UTC format.
+    # This date may be in the past, however it may not be in the future.
+    # Default: **current date/time**
+    # @return [DateTime]
+    attr_accessor :action_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['points'] = 'Points'
+      @_hash['source'] = 'Source'
+      @_hash['source_id'] = 'SourceId'
+      @_hash['action'] = 'Action'
+      @_hash['action_date_time'] = 'ActionDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source
+        source_id
+        action_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, points = nil, action = nil, source = SKIP,
+                   source_id = SKIP, action_date_time = SKIP)
+      @client_id = client_id
+      @points = points
+      @source = source unless source == SKIP
+      @source_id = source_id unless source_id == SKIP
+      @action = action
+      @action_date_time = action_date_time unless action_date_time == 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
+      points = hash.key?('Points') ? hash['Points'] : nil
+      action = hash.key?('Action') ? hash['Action'] : nil
+      source = hash.key?('Source') ? hash['Source'] : SKIP
+      source_id = hash.key?('SourceId') ? hash['SourceId'] : SKIP
+      action_date_time = if hash.key?('ActionDateTime')
+                           (DateTimeHelper.from_rfc3339(hash['ActionDateTime']) if hash['ActionDateTime'])
+                         else
+                           SKIP
+                         end
+
+      # Create object from extracted values.
+      UpdateClientRewardsRequest.new(client_id,
+                                     points,
+                                     action,
+                                     source,
+                                     source_id,
+                                     action_date_time)
+    end
+
+    def to_custom_action_date_time
+      DateTimeHelper.to_rfc3339(action_date_time)
+    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}, points: #{@points}, source: #{@source},"\
+      " source_id: #{@source_id}, action: #{@action}, action_date_time: #{@action_date_time}>"
+    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}, points: #{@points.inspect}, source:"\
+      " #{@source.inspect}, source_id: #{@source_id.inspect}, action: #{@action.inspect},"\
+      " action_date_time: #{@action_date_time.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/update_client_service_request.rb

@@ -0,0 +1,121 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # UpdateClientServiceRequest Model.
+  class UpdateClientServiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the service to update.
+    # @return [Integer]
+    attr_accessor :service_id
+
+    # The date that the service became active.
+    # @return [DateTime]
+    attr_accessor :active_date
+
+    # The date that the service is to expire.
+    # @return [DateTime]
+    attr_accessor :expiration_date
+
+    # The number of client service sessions to update.
+    # @return [Integer]
+    attr_accessor :count
+
+    # When `true`, indicates that input information is to be validated, but not
+    # committed.<br />
+    # When `false` or omitted, the database is affected.<br />
+    # 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['service_id'] = 'ServiceId'
+      @_hash['active_date'] = 'ActiveDate'
+      @_hash['expiration_date'] = 'ExpirationDate'
+      @_hash['count'] = 'Count'
+      @_hash['test'] = 'Test'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        active_date
+        expiration_date
+        count
+        test
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_id = nil, active_date = SKIP, expiration_date = SKIP,
+                   count = SKIP, test = SKIP)
+      @service_id = service_id
+      @active_date = active_date unless active_date == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @count = count unless count == 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.
+      service_id = hash.key?('ServiceId') ? hash['ServiceId'] : nil
+      active_date = if hash.key?('ActiveDate')
+                      (DateTimeHelper.from_rfc3339(hash['ActiveDate']) if hash['ActiveDate'])
+                    else
+                      SKIP
+                    end
+      expiration_date = if hash.key?('ExpirationDate')
+                          (DateTimeHelper.from_rfc3339(hash['ExpirationDate']) if hash['ExpirationDate'])
+                        else
+                          SKIP
+                        end
+      count = hash.key?('Count') ? hash['Count'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+
+      # Create object from extracted values.
+      UpdateClientServiceRequest.new(service_id,
+                                     active_date,
+                                     expiration_date,
+                                     count,
+                                     test)
+    end
+
+    def to_custom_active_date
+      DateTimeHelper.to_rfc3339(active_date)
+    end
+
+    def to_custom_expiration_date
+      DateTimeHelper.to_rfc3339(expiration_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_id: #{@service_id}, active_date: #{@active_date}, expiration_date:"\
+      " #{@expiration_date}, count: #{@count}, test: #{@test}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} service_id: #{@service_id.inspect}, active_date: #{@active_date.inspect},"\
+      " expiration_date: #{@expiration_date.inspect}, count: #{@count.inspect}, test:"\
+      " #{@test.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/update_client_service_response.rb

@@ -0,0 +1,62 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # UpdateClientServiceResponse Model.
+  class UpdateClientServiceResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['client_service'] = 'ClientService'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_service
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_service = 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.
+      client_service = ClientService.from_hash(hash['ClientService']) if hash['ClientService']
+
+      # Create object from extracted values.
+      UpdateClientServiceResponse.new(client_service)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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} client_service: #{@client_service.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/update_client_visit_request.rb

@@ -0,0 +1,130 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # UpdateClientVisitRequest Model.
+  class UpdateClientVisitRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the visit to be updated.
+    # @return [Integer]
+    attr_accessor :visit_id
+
+    # When `true`, indicates that the visit is eligible to be made up.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :makeup
+
+    # When `true`, indicates that the client has signed in for the visit.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :signed_in
+
+    # The ID of the service to assign to the visit.
+    # @return [Integer]
+    attr_accessor :client_service_id
+
+    # The execute code used to update this visit. Possible values are:
+    # * Cancel
+    # * Latecancel
+    # * Unlatecancel
+    # @return [String]
+    attr_accessor :execute
+
+    # When `true`, indicates that test mode is enabled. When test mode is
+    # enabled, 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 for
+    # cancellations. Note that email is not sent unless the client has an email
+    # address and automatic emails have been set up correctly.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['visit_id'] = 'VisitId'
+      @_hash['makeup'] = 'Makeup'
+      @_hash['signed_in'] = 'SignedIn'
+      @_hash['client_service_id'] = 'ClientServiceId'
+      @_hash['execute'] = 'Execute'
+      @_hash['test'] = 'Test'
+      @_hash['send_email'] = 'SendEmail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        makeup
+        signed_in
+        client_service_id
+        execute
+        test
+        send_email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(visit_id = nil, makeup = SKIP, signed_in = SKIP,
+                   client_service_id = SKIP, execute = SKIP, test = SKIP,
+                   send_email = SKIP)
+      @visit_id = visit_id
+      @makeup = makeup unless makeup == SKIP
+      @signed_in = signed_in unless signed_in == SKIP
+      @client_service_id = client_service_id unless client_service_id == SKIP
+      @execute = execute unless execute == SKIP
+      @test = test unless test == SKIP
+      @send_email = send_email unless send_email == 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.
+      visit_id = hash.key?('VisitId') ? hash['VisitId'] : nil
+      makeup = hash.key?('Makeup') ? hash['Makeup'] : SKIP
+      signed_in = hash.key?('SignedIn') ? hash['SignedIn'] : SKIP
+      client_service_id =
+        hash.key?('ClientServiceId') ? hash['ClientServiceId'] : SKIP
+      execute = hash.key?('Execute') ? hash['Execute'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      send_email = hash.key?('SendEmail') ? hash['SendEmail'] : SKIP
+
+      # Create object from extracted values.
+      UpdateClientVisitRequest.new(visit_id,
+                                   makeup,
+                                   signed_in,
+                                   client_service_id,
+                                   execute,
+                                   test,
+                                   send_email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} visit_id: #{@visit_id}, makeup: #{@makeup}, signed_in: #{@signed_in},"\
+      " client_service_id: #{@client_service_id}, execute: #{@execute}, test: #{@test},"\
+      " send_email: #{@send_email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} visit_id: #{@visit_id.inspect}, makeup: #{@makeup.inspect}, signed_in:"\
+      " #{@signed_in.inspect}, client_service_id: #{@client_service_id.inspect}, execute:"\
+      " #{@execute.inspect}, test: #{@test.inspect}, send_email: #{@send_email.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/update_client_visit_response.rb

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

data/lib/mindbody_public_api/models/update_contact_log_comment.rb

@@ -0,0 +1,72 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # UpdateContactLogComment Model.
+  class UpdateContactLogComment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the contact log comment to be updated. Pass a value of `0` to
+    # add a new comment to the contact log.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The new text for the comment.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['text'] = 'Text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, text = SKIP)
+      @id = id unless id == SKIP
+      @text = text unless text == 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
+      text = hash.key?('Text') ? hash['Text'] : SKIP
+
+      # Create object from extracted values.
+      UpdateContactLogComment.new(id,
+                                  text)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, text: #{@text}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, text: #{@text.inspect}>"
+    end
+  end
+end