mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_client_visits_response.rb

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

data/lib/mindbody_public_api/models/get_clients_request.rb

@@ -0,0 +1,157 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetClientsRequest Model.
+  class GetClientsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The requested client IDs.
+    # Default: **all IDs** that the authenticated user’s access level allows.<br
+    # />
+    # Note: You can fetch information for maximum 20 clients at once.
+    # @return [Array[String]]
+    attr_accessor :client_i_ds
+
+    # Text to use in the search. Can include FirstName, LastName, and Email.
+    # Note that user credentials must be provided.
+    # @return [String]
+    attr_accessor :search_text
+
+    # When `true`, filters the results to include only those clients marked as
+    # prospects for the business.<br />
+    # When `false`, indicates that only those clients who are not marked
+    # prospects should be returned.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_prospect
+
+    # Filters the results to include only the clients that have been modified on
+    # or after this date.
+    # @return [DateTime]
+    attr_accessor :last_modified_date
+
+    # Filters results to clients with these `UniqueIDs`. This parameter cannot
+    # be used with `ClientIDs` or `SearchText`.
+    # Default: **all UniqueIDs** that the authenticated user’s access level
+    # allows.
+    # @return [Array[Integer]]
+    attr_accessor :unique_ids
+
+    # When `true`, indicates the results to include active and inactive
+    # clients.<br />
+    # When `false`, indicates that only those clients who are marked as active
+    # should be returned.
+    # Default: **false**
+    # @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['client_i_ds'] = 'ClientIDs'
+      @_hash['search_text'] = 'SearchText'
+      @_hash['is_prospect'] = 'IsProspect'
+      @_hash['last_modified_date'] = 'LastModifiedDate'
+      @_hash['unique_ids'] = 'UniqueIds'
+      @_hash['include_inactive'] = 'IncludeInactive'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_i_ds
+        search_text
+        is_prospect
+        last_modified_date
+        unique_ids
+        include_inactive
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_i_ds = SKIP, search_text = SKIP, is_prospect = SKIP,
+                   last_modified_date = SKIP, unique_ids = SKIP,
+                   include_inactive = SKIP, limit = SKIP, offset = SKIP)
+      @client_i_ds = client_i_ds unless client_i_ds == SKIP
+      @search_text = search_text unless search_text == SKIP
+      @is_prospect = is_prospect unless is_prospect == SKIP
+      @last_modified_date = last_modified_date unless last_modified_date == SKIP
+      @unique_ids = unique_ids unless unique_ids == 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.
+      client_i_ds = hash.key?('ClientIDs') ? hash['ClientIDs'] : SKIP
+      search_text = hash.key?('SearchText') ? hash['SearchText'] : SKIP
+      is_prospect = hash.key?('IsProspect') ? hash['IsProspect'] : SKIP
+      last_modified_date = if hash.key?('LastModifiedDate')
+                             (DateTimeHelper.from_rfc3339(hash['LastModifiedDate']) if hash['LastModifiedDate'])
+                           else
+                             SKIP
+                           end
+      unique_ids = hash.key?('UniqueIds') ? hash['UniqueIds'] : 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.
+      GetClientsRequest.new(client_i_ds,
+                            search_text,
+                            is_prospect,
+                            last_modified_date,
+                            unique_ids,
+                            include_inactive,
+                            limit,
+                            offset)
+    end
+
+    def to_custom_last_modified_date
+      DateTimeHelper.to_rfc3339(last_modified_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_i_ds: #{@client_i_ds}, search_text: #{@search_text}, is_prospect:"\
+      " #{@is_prospect}, last_modified_date: #{@last_modified_date}, unique_ids: #{@unique_ids},"\
+      " 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} client_i_ds: #{@client_i_ds.inspect}, search_text: #{@search_text.inspect},"\
+      " is_prospect: #{@is_prospect.inspect}, last_modified_date: #{@last_modified_date.inspect},"\
+      " unique_ids: #{@unique_ids.inspect}, include_inactive: #{@include_inactive.inspect}, limit:"\
+      " #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_clients_response.rb

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

data/lib/mindbody_public_api/models/get_commissions_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
+  # GetCommissionsRequest Model.
+  class GetCommissionsRequest < 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.
+      GetCommissionsRequest.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

data/lib/mindbody_public_api/models/get_commissions_response.rb

@@ -0,0 +1,84 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetCommissionsResponse Model.
+  class GetCommissionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the pagination to use.
+    # @return [PaginationResponse]
+    attr_accessor :pagination_response
+
+    # Contains information about commissions earned by staff for sales within
+    # the given date range. Results are ordered by `SaleId`, then by `StaffId`.
+    # @return [Array[CommissionPayrollPurchaseEvent]]
+    attr_accessor :commissions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination_response'] = 'PaginationResponse'
+      @_hash['commissions'] = 'Commissions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination_response
+        commissions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination_response = SKIP, commissions = SKIP)
+      @pagination_response = pagination_response unless pagination_response == SKIP
+      @commissions = commissions unless commissions == 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
+      commissions = nil
+      unless hash['Commissions'].nil?
+        commissions = []
+        hash['Commissions'].each do |structure|
+          commissions << (CommissionPayrollPurchaseEvent.from_hash(structure) if structure)
+        end
+      end
+
+      commissions = SKIP unless hash.key?('Commissions')
+
+      # Create object from extracted values.
+      GetCommissionsResponse.new(pagination_response,
+                                 commissions)
+    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}, commissions:"\
+      " #{@commissions}>"
+    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}, commissions:"\
+      " #{@commissions.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_contact_log_types_request.rb

@@ -0,0 +1,84 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetContactLogTypesRequest Model.
+  class GetContactLogTypesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The requested ContactLogType ID.
+    # Default: **all** IDs that the authenticated user’s access level allows.
+    # @return [Integer]
+    attr_accessor :contact_log_type_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['contact_log_type_id'] = 'ContactLogTypeId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_log_type_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contact_log_type_id = SKIP, limit = SKIP, offset = SKIP)
+      @contact_log_type_id = contact_log_type_id unless contact_log_type_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.
+      contact_log_type_id =
+        hash.key?('ContactLogTypeId') ? hash['ContactLogTypeId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetContactLogTypesRequest.new(contact_log_type_id,
+                                    limit,
+                                    offset)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contact_log_type_id: #{@contact_log_type_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} contact_log_type_id: #{@contact_log_type_id.inspect}, limit:"\
+      " #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end