mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_staff_permissions_request.rb

@@ -0,0 +1,60 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetStaffPermissionsRequest Model.
+  class GetStaffPermissionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the staff member whose permissions you want to return.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = nil)
+      @staff_id = staff_id
+    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'] : nil
+
+      # Create object from extracted values.
+      GetStaffPermissionsRequest.new(staff_id)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_staff_permissions_response.rb

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

data/lib/mindbody_public_api/models/get_staff_request.rb

@@ -0,0 +1,144 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetStaffRequest Model.
+  class GetStaffRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of the requested staff IDs.
+    # @return [Array[Integer]]
+    attr_accessor :staff_ids
+
+    # Filters to apply to the search. Possible values are:
+    # * StaffViewable
+    # * AppointmentInstructor
+    # * ClassInstructor
+    # * Male
+    # * Female
+    # @return [Array[String]]
+    attr_accessor :filters
+
+    # Return only staff members that are available for the specified session
+    # type. You must supply a valid `StartDateTime` and `LocationID` to use this
+    # parameter.
+    # @return [Integer]
+    attr_accessor :session_type_id
+
+    # Return only staff members that are available at the specified date and
+    # time. You must supply a valid `SessionTypeID` and `LocationID` to use this
+    # parameter.
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # Return only staff members that are available at the specified location.
+    # You must supply a valid `SessionTypeID` and `StartDateTime` to use this
+    # parameter.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Number of results to include, defaults to 100
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Page offset, defaults to 0.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_ids'] = 'StaffIds'
+      @_hash['filters'] = 'Filters'
+      @_hash['session_type_id'] = 'SessionTypeId'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_ids
+        filters
+        session_type_id
+        start_date_time
+        location_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_ids = SKIP, filters = SKIP, session_type_id = SKIP,
+                   start_date_time = SKIP, location_id = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @staff_ids = staff_ids unless staff_ids == SKIP
+      @filters = filters unless filters == SKIP
+      @session_type_id = session_type_id unless session_type_id == SKIP
+      @start_date_time = start_date_time unless start_date_time == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @limit = limit unless limit == SKIP
+      @offset = offset unless offset == 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_ids = hash.key?('StaffIds') ? hash['StaffIds'] : SKIP
+      filters = hash.key?('Filters') ? hash['Filters'] : SKIP
+      session_type_id =
+        hash.key?('SessionTypeId') ? hash['SessionTypeId'] : SKIP
+      start_date_time = if hash.key?('StartDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['StartDateTime']) if hash['StartDateTime'])
+                        else
+                          SKIP
+                        end
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetStaffRequest.new(staff_ids,
+                          filters,
+                          session_type_id,
+                          start_date_time,
+                          location_id,
+                          limit,
+                          offset)
+    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} staff_ids: #{@staff_ids}, filters: #{@filters}, session_type_id:"\
+      " #{@session_type_id}, start_date_time: #{@start_date_time}, location_id: #{@location_id},"\
+      " limit: #{@limit}, offset: #{@offset}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} staff_ids: #{@staff_ids.inspect}, filters: #{@filters.inspect},"\
+      " session_type_id: #{@session_type_id.inspect}, start_date_time:"\
+      " #{@start_date_time.inspect}, location_id: #{@location_id.inspect}, limit:"\
+      " #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_staff_response.rb

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

data/lib/mindbody_public_api/models/get_staff_session_types_request.rb

@@ -0,0 +1,104 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetStaffSessionTypesRequest Model.
+  class GetStaffSessionTypesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the staff member whose session types you want to return.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # Filters results to session types that belong to one of the given program
+    # IDs. If omitted, all program IDs return.
+    # @return [Array[Integer]]
+    attr_accessor :program_ids
+
+    # When `true`, indicates that only the session types that can be booked
+    # online should be returned.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :online_only
+
+    # Number of results to include, defaults to 100
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Page offset, defaults to 0.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['program_ids'] = 'ProgramIds'
+      @_hash['online_only'] = 'OnlineOnly'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        program_ids
+        online_only
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = nil, program_ids = SKIP, online_only = SKIP,
+                   limit = SKIP, offset = SKIP)
+      @staff_id = staff_id
+      @program_ids = program_ids unless program_ids == SKIP
+      @online_only = online_only unless online_only == SKIP
+      @limit = limit unless limit == SKIP
+      @offset = offset unless offset == 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'] : nil
+      program_ids = hash.key?('ProgramIds') ? hash['ProgramIds'] : SKIP
+      online_only = hash.key?('OnlineOnly') ? hash['OnlineOnly'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetStaffSessionTypesRequest.new(staff_id,
+                                      program_ids,
+                                      online_only,
+                                      limit,
+                                      offset)
+    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}, program_ids: #{@program_ids}, online_only:"\
+      " #{@online_only}, limit: #{@limit}, offset: #{@offset}>"
+    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}, program_ids: #{@program_ids.inspect},"\
+      " online_only: #{@online_only.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_staff_session_types_response.rb

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

data/lib/mindbody_public_api/models/get_time_cards_request.rb

@@ -0,0 +1,144 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetTimeCardsRequest Model.
+  class GetTimeCardsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of staff IDs that you want to retrieve payroll information for. If
+    # you do not supply a `StaffId`, all active staff members return, ordered by
+    # staff ID.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The beginning of the date range for the payroll information to be
+    # returned. The maximum allowed date range is 14 days.
+    # * If you do not supply a `StartDateTime`, data returns for the seven days
+    # prior to the `EndDateTime` that you supply.
+    # * If you do not supply either a `StartDateTime` or an `EndDateTime`, the
+    # data returns for seven days prior to today’s date.
+    # @return [DateTime]
+    attr_accessor :start_date_time
+
+    # The end of the date range for the payroll information to be returned. The
+    # maximum allowed date range is 14 days.<br />
+    # Default: **Today’s date**
+    # * If you do not supply an `EndDateTime`, the data returns for the period
+    # from the `StartDateTime` that you supply to today’s date.
+    # * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns
+    # for the seven days prior to today’s date.
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # A LocationId that you want to retrieve payroll information for. If you do
+    # not supply a `LocationId`, data from all locations is returned.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Number of results to include, defaults to 100
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Page offset, defaults to 0.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        start_date_time
+        end_date_time
+        location_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, start_date_time = SKIP,
+                   end_date_time = SKIP, location_id = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @start_date_time = start_date_time unless start_date_time == SKIP
+      @end_date_time = end_date_time unless end_date_time == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @limit = limit unless limit == SKIP
+      @offset = offset unless offset == 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
+      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
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetTimeCardsRequest.new(staff_id,
+                              start_date_time,
+                              end_date_time,
+                              location_id,
+                              limit,
+                              offset)
+    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
+
+    # 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}, start_date_time: #{@start_date_time},"\
+      " end_date_time: #{@end_date_time}, location_id: #{@location_id}, limit: #{@limit}, offset:"\
+      " #{@offset}>"
+    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}, start_date_time:"\
+      " #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect}, location_id:"\
+      " #{@location_id.inspect}, limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end