mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_bookable_items_request.rb

@@ -0,0 +1,190 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetBookableItemsRequest Model.
+  class GetBookableItemsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of the requested session type IDs.
+    # @return [Array[Integer]]
+    attr_accessor :session_type_ids
+
+    # A list of the requested location IDs.
+    # @return [Array[Integer]]
+    attr_accessor :location_ids
+
+    # A list of the requested staff IDs. Omit parameter to return all staff
+    # availabilities.
+    # @return [Array[Integer]]
+    attr_accessor :staff_ids
+
+    # The start date of the requested date range. 
+    # <br />Default: **today’s date**
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the requested date range. 
+    # <br />Default: **StartDate**
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # If provided, filters out the appointment with this ID.
+    # @return [Integer]
+    attr_accessor :appointment_id
+
+    # When `true`, availabilities that are non-default return, for example, a
+    # 30-minute availability with a 60-minute default session length.<br />
+    # When `false`, only availabilities that have the default session length
+    # return.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ignore_default_session_length
+
+    # When `true`, resource availabilities for the session type are returned.<br
+    # />
+    # When `false`, resource availabilities are not returned default.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_resource_availability
+
+    # 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['session_type_ids'] = 'SessionTypeIds'
+      @_hash['location_ids'] = 'LocationIds'
+      @_hash['staff_ids'] = 'StaffIds'
+      @_hash['start_date'] = 'StartDate'
+      @_hash['end_date'] = 'EndDate'
+      @_hash['appointment_id'] = 'AppointmentId'
+      @_hash['ignore_default_session_length'] = 'IgnoreDefaultSessionLength'
+      @_hash['include_resource_availability'] = 'IncludeResourceAvailability'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_ids
+        staff_ids
+        start_date
+        end_date
+        appointment_id
+        ignore_default_session_length
+        include_resource_availability
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(session_type_ids = nil, location_ids = SKIP,
+                   staff_ids = SKIP, start_date = SKIP, end_date = SKIP,
+                   appointment_id = SKIP, ignore_default_session_length = SKIP,
+                   include_resource_availability = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @session_type_ids = session_type_ids
+      @location_ids = location_ids unless location_ids == SKIP
+      @staff_ids = staff_ids unless staff_ids == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @appointment_id = appointment_id unless appointment_id == SKIP
+      unless ignore_default_session_length == SKIP
+        @ignore_default_session_length =
+          ignore_default_session_length
+      end
+      unless include_resource_availability == SKIP
+        @include_resource_availability =
+          include_resource_availability
+      end
+      @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.
+      session_type_ids =
+        hash.key?('SessionTypeIds') ? hash['SessionTypeIds'] : nil
+      location_ids = hash.key?('LocationIds') ? hash['LocationIds'] : SKIP
+      staff_ids = hash.key?('StaffIds') ? hash['StaffIds'] : SKIP
+      start_date = if hash.key?('StartDate')
+                     (DateTimeHelper.from_rfc3339(hash['StartDate']) if hash['StartDate'])
+                   else
+                     SKIP
+                   end
+      end_date = if hash.key?('EndDate')
+                   (DateTimeHelper.from_rfc3339(hash['EndDate']) if hash['EndDate'])
+                 else
+                   SKIP
+                 end
+      appointment_id = hash.key?('AppointmentId') ? hash['AppointmentId'] : SKIP
+      ignore_default_session_length =
+        hash.key?('IgnoreDefaultSessionLength') ? hash['IgnoreDefaultSessionLength'] : SKIP
+      include_resource_availability =
+        hash.key?('IncludeResourceAvailability') ? hash['IncludeResourceAvailability'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetBookableItemsRequest.new(session_type_ids,
+                                  location_ids,
+                                  staff_ids,
+                                  start_date,
+                                  end_date,
+                                  appointment_id,
+                                  ignore_default_session_length,
+                                  include_resource_availability,
+                                  limit,
+                                  offset)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} session_type_ids: #{@session_type_ids}, location_ids: #{@location_ids},"\
+      " staff_ids: #{@staff_ids}, start_date: #{@start_date}, end_date: #{@end_date},"\
+      " appointment_id: #{@appointment_id}, ignore_default_session_length:"\
+      " #{@ignore_default_session_length}, include_resource_availability:"\
+      " #{@include_resource_availability}, 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} session_type_ids: #{@session_type_ids.inspect}, location_ids:"\
+      " #{@location_ids.inspect}, staff_ids: #{@staff_ids.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, appointment_id:"\
+      " #{@appointment_id.inspect}, ignore_default_session_length:"\
+      " #{@ignore_default_session_length.inspect}, include_resource_availability:"\
+      " #{@include_resource_availability.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_bookable_items_response.rb

@@ -0,0 +1,83 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetBookableItemsResponse Model.
+  class GetBookableItemsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the pagination to use.
+    # @return [PaginationResponse]
+    attr_accessor :pagination_response
+
+    # Contains information about the availabilities for appointment booking.
+    # @return [Array[Availability]]
+    attr_accessor :availabilities
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination_response'] = 'PaginationResponse'
+      @_hash['availabilities'] = 'Availabilities'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination_response
+        availabilities
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination_response = SKIP, availabilities = SKIP)
+      @pagination_response = pagination_response unless pagination_response == SKIP
+      @availabilities = availabilities unless availabilities == 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
+      availabilities = nil
+      unless hash['Availabilities'].nil?
+        availabilities = []
+        hash['Availabilities'].each do |structure|
+          availabilities << (Availability.from_hash(structure) if structure)
+        end
+      end
+
+      availabilities = SKIP unless hash.key?('Availabilities')
+
+      # Create object from extracted values.
+      GetBookableItemsResponse.new(pagination_response,
+                                   availabilities)
+    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}, availabilities:"\
+      " #{@availabilities}>"
+    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}, availabilities:"\
+      " #{@availabilities.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_categories_request.rb

@@ -0,0 +1,118 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Get Categories Request Model
+  class GetCategoriesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When included, the response only contains details about the specified
+    # category Ids.
+    # @return [Array[Integer]]
+    attr_accessor :category_ids
+
+    # When included, the response only contains details about the specified
+    # subcategory Ids.
+    # @return [Array[Integer]]
+    attr_accessor :sub_category_ids
+
+    # When `true`, the response only contains details about Revenue Categories.
+    # When `false`, only Product Revenue Categories are returned.
+    # Default: **All Categories**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :service
+
+    # When `true`, the response only contains categories which are activated. 
+    # When `false`, only deactivated categories are returned.
+    # Default: **All Categories**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # 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['category_ids'] = 'CategoryIds'
+      @_hash['sub_category_ids'] = 'SubCategoryIds'
+      @_hash['service'] = 'Service'
+      @_hash['active'] = 'Active'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_ids
+        sub_category_ids
+        service
+        active
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category_ids = SKIP, sub_category_ids = SKIP, service = SKIP,
+                   active = SKIP, limit = SKIP, offset = SKIP)
+      @category_ids = category_ids unless category_ids == SKIP
+      @sub_category_ids = sub_category_ids unless sub_category_ids == SKIP
+      @service = service unless service == SKIP
+      @active = active unless active == 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.
+      category_ids = hash.key?('CategoryIds') ? hash['CategoryIds'] : SKIP
+      sub_category_ids =
+        hash.key?('SubCategoryIds') ? hash['SubCategoryIds'] : SKIP
+      service = hash.key?('Service') ? hash['Service'] : SKIP
+      active = hash.key?('Active') ? hash['Active'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetCategoriesRequest.new(category_ids,
+                               sub_category_ids,
+                               service,
+                               active,
+                               limit,
+                               offset)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} category_ids: #{@category_ids}, sub_category_ids: #{@sub_category_ids},"\
+      " service: #{@service}, active: #{@active}, 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} category_ids: #{@category_ids.inspect}, sub_category_ids:"\
+      " #{@sub_category_ids.inspect}, service: #{@service.inspect}, active: #{@active.inspect},"\
+      " limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_categories_response.rb

@@ -0,0 +1,83 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Get Categories Response Model
+  class GetCategoriesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the pagination to use.
+    # @return [PaginationResponse]
+    attr_accessor :pagination_response
+
+    # Contains the Category objects, each of which describes the categories for
+    # a site.
+    # @return [Array[Category]]
+    attr_accessor :categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination_response'] = 'PaginationResponse'
+      @_hash['categories'] = 'Categories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination_response
+        categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination_response = SKIP, categories = SKIP)
+      @pagination_response = pagination_response unless pagination_response == SKIP
+      @categories = categories unless categories == 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
+      categories = nil
+      unless hash['Categories'].nil?
+        categories = []
+        hash['Categories'].each do |structure|
+          categories << (Category.from_hash(structure) if structure)
+        end
+      end
+
+      categories = SKIP unless hash.key?('Categories')
+
+      # Create object from extracted values.
+      GetCategoriesResponse.new(pagination_response,
+                                categories)
+    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}, categories: #{@categories}>"
+    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}, categories:"\
+      " #{@categories.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_class_descriptions_request.rb

@@ -0,0 +1,168 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetClassDescriptionsRequest Model.
+  class GetClassDescriptionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the requested client.
+    # @return [Integer]
+    attr_accessor :class_description_id
+
+    # A list of requested program IDs.
+    # @return [Array[Integer]]
+    attr_accessor :program_ids
+
+    # Filters the results to class descriptions for scheduled classes that
+    # happen on or after the given date and time.
+    # @return [DateTime]
+    attr_accessor :start_class_date_time
+
+    # Filters the results to class descriptions for scheduled classes that
+    # happen before the given date and time.
+    # @return [DateTime]
+    attr_accessor :end_class_date_time
+
+    # Filters results to class descriptions for scheduled classes taught by the
+    # given staff member.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # Filters results to classes descriptions for schedule classes as the given
+    # location.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Includes inactive class descriptions, defaulting to true. When set to
+    # false, it filters out inactive class descriptions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_inactive
+
+    # 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['class_description_id'] = 'ClassDescriptionId'
+      @_hash['program_ids'] = 'ProgramIds'
+      @_hash['start_class_date_time'] = 'StartClassDateTime'
+      @_hash['end_class_date_time'] = 'EndClassDateTime'
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['include_inactive'] = 'IncludeInactive'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        class_description_id
+        program_ids
+        start_class_date_time
+        end_class_date_time
+        staff_id
+        location_id
+        include_inactive
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(class_description_id = SKIP, program_ids = SKIP,
+                   start_class_date_time = SKIP, end_class_date_time = SKIP,
+                   staff_id = SKIP, location_id = SKIP, include_inactive = SKIP,
+                   limit = SKIP, offset = SKIP)
+      @class_description_id = class_description_id unless class_description_id == SKIP
+      @program_ids = program_ids unless program_ids == SKIP
+      @start_class_date_time = start_class_date_time unless start_class_date_time == SKIP
+      @end_class_date_time = end_class_date_time unless end_class_date_time == SKIP
+      @staff_id = staff_id unless staff_id == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @include_inactive = include_inactive unless include_inactive == 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.
+      class_description_id =
+        hash.key?('ClassDescriptionId') ? hash['ClassDescriptionId'] : SKIP
+      program_ids = hash.key?('ProgramIds') ? hash['ProgramIds'] : SKIP
+      start_class_date_time = if hash.key?('StartClassDateTime')
+                                (DateTimeHelper.from_rfc3339(hash['StartClassDateTime']) if hash['StartClassDateTime'])
+                              else
+                                SKIP
+                              end
+      end_class_date_time = if hash.key?('EndClassDateTime')
+                              (DateTimeHelper.from_rfc3339(hash['EndClassDateTime']) if hash['EndClassDateTime'])
+                            else
+                              SKIP
+                            end
+      staff_id = hash.key?('StaffId') ? hash['StaffId'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      include_inactive =
+        hash.key?('IncludeInactive') ? hash['IncludeInactive'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetClassDescriptionsRequest.new(class_description_id,
+                                      program_ids,
+                                      start_class_date_time,
+                                      end_class_date_time,
+                                      staff_id,
+                                      location_id,
+                                      include_inactive,
+                                      limit,
+                                      offset)
+    end
+
+    def to_custom_start_class_date_time
+      DateTimeHelper.to_rfc3339(start_class_date_time)
+    end
+
+    def to_custom_end_class_date_time
+      DateTimeHelper.to_rfc3339(end_class_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} class_description_id: #{@class_description_id}, program_ids:"\
+      " #{@program_ids}, start_class_date_time: #{@start_class_date_time}, end_class_date_time:"\
+      " #{@end_class_date_time}, staff_id: #{@staff_id}, location_id: #{@location_id},"\
+      " include_inactive: #{@include_inactive}, 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} class_description_id: #{@class_description_id.inspect}, program_ids:"\
+      " #{@program_ids.inspect}, start_class_date_time: #{@start_class_date_time.inspect},"\
+      " end_class_date_time: #{@end_class_date_time.inspect}, staff_id: #{@staff_id.inspect},"\
+      " location_id: #{@location_id.inspect}, include_inactive: #{@include_inactive.inspect},"\
+      " limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end