mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/client_duplicate.rb

@@ -0,0 +1,109 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A client record that is considered a duplicate based on matching of the
+  # client's first name, last name, AND email fields
+  class ClientDuplicate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The client’s ID, as configured by the business owner. This is the client’s
+    # barcode ID if the business owner assigns barcodes to clients. This ID is
+    # used throughout the Public API for client-related Public API calls. When
+    # used in a POST `UpdateClient` request, the `Id` is used to identify the
+    # client for the update.
+    # @return [String]
+    attr_accessor :id
+
+    # The client’s system-generated ID at the business. This value cannot be
+    # changed by business owners and is always unique across all clients at the
+    # business. This ID is not widely used in the Public API, but can be used by
+    # your application to uniquely identify clients.
+    # @return [Integer]
+    attr_accessor :unique_id
+
+    # The client’s first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # The client’s last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The client’s email address.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['unique_id'] = 'UniqueId'
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['email'] = 'Email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        unique_id
+        first_name
+        last_name
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, unique_id = SKIP, first_name = SKIP,
+                   last_name = SKIP, email = SKIP)
+      @id = id unless id == SKIP
+      @unique_id = unique_id unless unique_id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @email = email unless 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      unique_id = hash.key?('UniqueId') ? hash['UniqueId'] : SKIP
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      email = hash.key?('Email') ? hash['Email'] : SKIP
+
+      # Create object from extracted values.
+      ClientDuplicate.new(id,
+                          unique_id,
+                          first_name,
+                          last_name,
+                          email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, unique_id: #{@unique_id}, first_name: #{@first_name},"\
+      " last_name: #{@last_name}, email: #{@email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, unique_id: #{@unique_id.inspect}, first_name:"\
+      " #{@first_name.inspect}, last_name: #{@last_name.inspect}, email: #{@email.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_index.rb

@@ -0,0 +1,127 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A client index.
+  class ClientIndex < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID of the client index.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of the client index.
+    # @return [String]
+    attr_accessor :name
+
+    # When `true`, indicates that the index is required when creating profiles
+    # in business mode.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :required_business_mode
+
+    # When `true`, indicates that the index is required when creating profiles
+    # in consumer mode.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :required_consumer_mode
+
+    # Contains a list with a single object representing the index value assigned
+    # to the client index.
+    # @return [Array[ClientIndexValue]]
+    attr_accessor :values
+
+    # The action performed on this object.
+    # @return [Action8Enum]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['name'] = 'Name'
+      @_hash['required_business_mode'] = 'RequiredBusinessMode'
+      @_hash['required_consumer_mode'] = 'RequiredConsumerMode'
+      @_hash['values'] = 'Values'
+      @_hash['action'] = 'Action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        required_business_mode
+        required_consumer_mode
+        values
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP, required_business_mode = SKIP,
+                   required_consumer_mode = SKIP, values = SKIP, action = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @required_business_mode = required_business_mode unless required_business_mode == SKIP
+      @required_consumer_mode = required_consumer_mode unless required_consumer_mode == SKIP
+      @values = values unless values == SKIP
+      @action = action unless action == 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
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      required_business_mode =
+        hash.key?('RequiredBusinessMode') ? hash['RequiredBusinessMode'] : SKIP
+      required_consumer_mode =
+        hash.key?('RequiredConsumerMode') ? hash['RequiredConsumerMode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      values = nil
+      unless hash['Values'].nil?
+        values = []
+        hash['Values'].each do |structure|
+          values << (ClientIndexValue.from_hash(structure) if structure)
+        end
+      end
+
+      values = SKIP unless hash.key?('Values')
+      action = hash.key?('Action') ? hash['Action'] : SKIP
+
+      # Create object from extracted values.
+      ClientIndex.new(id,
+                      name,
+                      required_business_mode,
+                      required_consumer_mode,
+                      values,
+                      action)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, required_business_mode:"\
+      " #{@required_business_mode}, required_consumer_mode: #{@required_consumer_mode}, values:"\
+      " #{@values}, action: #{@action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, required_business_mode:"\
+      " #{@required_business_mode.inspect}, required_consumer_mode:"\
+      " #{@required_consumer_mode.inspect}, values: #{@values.inspect}, action:"\
+      " #{@action.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_index_value.rb

@@ -0,0 +1,82 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # A client index value.
+  class ClientIndexValue < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # For this call, this value is always `false` and can be ignored.
+    # When `false`, indicates that the index value has been deactivated and
+    # cannot be assigned to its parent index.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # The index value’s ID.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of the client index value.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['active'] = 'Active'
+      @_hash['id'] = 'Id'
+      @_hash['name'] = 'Name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        active
+        id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(active = SKIP, id = SKIP, name = SKIP)
+      @active = active unless active == SKIP
+      @id = id unless id == SKIP
+      @name = name unless name == 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.
+      active = hash.key?('Active') ? hash['Active'] : SKIP
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+
+      # Create object from extracted values.
+      ClientIndexValue.new(active,
+                           id,
+                           name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} active: #{@active}, id: #{@id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} active: #{@active.inspect}, id: #{@id.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_membership.rb

@@ -0,0 +1,272 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # ClientMembership Model.
+  class ClientMembership < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The locations that the membership is restricted to, if any.
+    # Please note that client memberships with location restrictions can only be
+    # used to pay for scheduled services at the site to which they belong.
+    # Memberships with location restrictions can not be used to pay for
+    # scheduled services at other sites within an organization.
+    # @return [Array[Location]]
+    attr_accessor :restricted_locations
+
+    # Text code that represents the `MembershipIcon`.
+    # @return [String]
+    attr_accessor :icon_code
+
+    # The membership's ID.
+    # @return [Integer]
+    attr_accessor :membership_id
+
+    # The date that this pricing option became active and could be used to pay
+    # for services.
+    # @return [DateTime]
+    attr_accessor :active_date
+
+    # The number of service sessions this pricing option contained when first
+    # purchased.
+    # @return [Integer]
+    attr_accessor :count
+
+    # When `true`, there are service sessions remaining on the pricing option
+    # that can be used pay for the current session.<br />
+    # When `false`, the client cannot use this pricing option to pay for other
+    # services.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :current
+
+    # The date when the pricing option expires and can no longer be used to pay
+    # for services, even if unused service sessions remain on the option;
+    # expressed as UTC.
+    # @return [DateTime]
+    attr_accessor :expiration_date
+
+    # The unique ID assigned to this pricing option, specific to when it was
+    # purchased by the client.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The unique ID of this pricing option, not specific to any client's
+    # purchase of it.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # The name of this pricing option.
+    # @return [String]
+    attr_accessor :name
+
+    # The date on which the client paid for this pricing option.
+    # @return [DateTime]
+    attr_accessor :payment_date
+
+    # The date on which the client paid for this pricing option.
+    # @return [Program]
+    attr_accessor :program
+
+    # The number of service sessions remaining in the pricing option that can
+    # still be used.
+    # @return [Integer]
+    attr_accessor :remaining
+
+    # The ID of the subscriber site associated with this pricing option.
+    # @return [Integer]
+    attr_accessor :site_id
+
+    # The action taken.
+    # @return [Action1Enum]
+    attr_accessor :action
+
+    # The Client ID assigned to this pricing option, specific to when it was
+    # purchased by the client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Identification for purchased service is returned or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :returned
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['restricted_locations'] = 'RestrictedLocations'
+      @_hash['icon_code'] = 'IconCode'
+      @_hash['membership_id'] = 'MembershipId'
+      @_hash['active_date'] = 'ActiveDate'
+      @_hash['count'] = 'Count'
+      @_hash['current'] = 'Current'
+      @_hash['expiration_date'] = 'ExpirationDate'
+      @_hash['id'] = 'Id'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['name'] = 'Name'
+      @_hash['payment_date'] = 'PaymentDate'
+      @_hash['program'] = 'Program'
+      @_hash['remaining'] = 'Remaining'
+      @_hash['site_id'] = 'SiteId'
+      @_hash['action'] = 'Action'
+      @_hash['client_id'] = 'ClientID'
+      @_hash['returned'] = 'Returned'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restricted_locations
+        icon_code
+        membership_id
+        active_date
+        count
+        current
+        expiration_date
+        id
+        product_id
+        name
+        payment_date
+        program
+        remaining
+        site_id
+        action
+        client_id
+        returned
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(restricted_locations = SKIP, icon_code = SKIP,
+                   membership_id = SKIP, active_date = SKIP, count = SKIP,
+                   current = SKIP, expiration_date = SKIP, id = SKIP,
+                   product_id = SKIP, name = SKIP, payment_date = SKIP,
+                   program = SKIP, remaining = SKIP, site_id = SKIP,
+                   action = SKIP, client_id = SKIP, returned = SKIP)
+      @restricted_locations = restricted_locations unless restricted_locations == SKIP
+      @icon_code = icon_code unless icon_code == SKIP
+      @membership_id = membership_id unless membership_id == SKIP
+      @active_date = active_date unless active_date == SKIP
+      @count = count unless count == SKIP
+      @current = current unless current == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @id = id unless id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @name = name unless name == SKIP
+      @payment_date = payment_date unless payment_date == SKIP
+      @program = program unless program == SKIP
+      @remaining = remaining unless remaining == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @action = action unless action == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @returned = returned unless returned == 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
+      restricted_locations = nil
+      unless hash['RestrictedLocations'].nil?
+        restricted_locations = []
+        hash['RestrictedLocations'].each do |structure|
+          restricted_locations << (Location.from_hash(structure) if structure)
+        end
+      end
+
+      restricted_locations = SKIP unless hash.key?('RestrictedLocations')
+      icon_code = hash.key?('IconCode') ? hash['IconCode'] : SKIP
+      membership_id = hash.key?('MembershipId') ? hash['MembershipId'] : SKIP
+      active_date = if hash.key?('ActiveDate')
+                      (DateTimeHelper.from_rfc3339(hash['ActiveDate']) if hash['ActiveDate'])
+                    else
+                      SKIP
+                    end
+      count = hash.key?('Count') ? hash['Count'] : SKIP
+      current = hash.key?('Current') ? hash['Current'] : SKIP
+      expiration_date = if hash.key?('ExpirationDate')
+                          (DateTimeHelper.from_rfc3339(hash['ExpirationDate']) if hash['ExpirationDate'])
+                        else
+                          SKIP
+                        end
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      payment_date = if hash.key?('PaymentDate')
+                       (DateTimeHelper.from_rfc3339(hash['PaymentDate']) if hash['PaymentDate'])
+                     else
+                       SKIP
+                     end
+      program = Program.from_hash(hash['Program']) if hash['Program']
+      remaining = hash.key?('Remaining') ? hash['Remaining'] : SKIP
+      site_id = hash.key?('SiteId') ? hash['SiteId'] : SKIP
+      action = hash.key?('Action') ? hash['Action'] : SKIP
+      client_id = hash.key?('ClientID') ? hash['ClientID'] : SKIP
+      returned = hash.key?('Returned') ? hash['Returned'] : SKIP
+
+      # Create object from extracted values.
+      ClientMembership.new(restricted_locations,
+                           icon_code,
+                           membership_id,
+                           active_date,
+                           count,
+                           current,
+                           expiration_date,
+                           id,
+                           product_id,
+                           name,
+                           payment_date,
+                           program,
+                           remaining,
+                           site_id,
+                           action,
+                           client_id,
+                           returned)
+    end
+
+    def to_custom_active_date
+      DateTimeHelper.to_rfc3339(active_date)
+    end
+
+    def to_custom_expiration_date
+      DateTimeHelper.to_rfc3339(expiration_date)
+    end
+
+    def to_custom_payment_date
+      DateTimeHelper.to_rfc3339(payment_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} restricted_locations: #{@restricted_locations}, icon_code: #{@icon_code},"\
+      " membership_id: #{@membership_id}, active_date: #{@active_date}, count: #{@count}, current:"\
+      " #{@current}, expiration_date: #{@expiration_date}, id: #{@id}, product_id: #{@product_id},"\
+      " name: #{@name}, payment_date: #{@payment_date}, program: #{@program}, remaining:"\
+      " #{@remaining}, site_id: #{@site_id}, action: #{@action}, client_id: #{@client_id},"\
+      " returned: #{@returned}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} restricted_locations: #{@restricted_locations.inspect}, icon_code:"\
+      " #{@icon_code.inspect}, membership_id: #{@membership_id.inspect}, active_date:"\
+      " #{@active_date.inspect}, count: #{@count.inspect}, current: #{@current.inspect},"\
+      " expiration_date: #{@expiration_date.inspect}, id: #{@id.inspect}, product_id:"\
+      " #{@product_id.inspect}, name: #{@name.inspect}, payment_date: #{@payment_date.inspect},"\
+      " program: #{@program.inspect}, remaining: #{@remaining.inspect}, site_id:"\
+      " #{@site_id.inspect}, action: #{@action.inspect}, client_id: #{@client_id.inspect},"\
+      " returned: #{@returned.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/client_memberships.rb

@@ -0,0 +1,91 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # ClientMemberships Model.
+  class ClientMemberships < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Contains information about the Client Memberships details.
+    # @return [Array[ClientMembership]]
+    attr_accessor :memberships
+
+    # Contains information about the Client Memberships details.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['memberships'] = 'Memberships'
+      @_hash['error_message'] = 'ErrorMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        memberships
+        error_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = SKIP, memberships = SKIP, error_message = SKIP)
+      @client_id = client_id unless client_id == SKIP
+      @memberships = memberships unless memberships == SKIP
+      @error_message = error_message unless error_message == 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'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      memberships = nil
+      unless hash['Memberships'].nil?
+        memberships = []
+        hash['Memberships'].each do |structure|
+          memberships << (ClientMembership.from_hash(structure) if structure)
+        end
+      end
+
+      memberships = SKIP unless hash.key?('Memberships')
+      error_message = hash.key?('ErrorMessage') ? hash['ErrorMessage'] : SKIP
+
+      # Create object from extracted values.
+      ClientMemberships.new(client_id,
+                            memberships,
+                            error_message)
+    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}, memberships: #{@memberships}, error_message:"\
+      " #{@error_message}>"
+    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}, memberships: #{@memberships.inspect},"\
+      " error_message: #{@error_message.inspect}>"
+    end
+  end
+end