mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_time_cards_response.rb

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

data/lib/mindbody_public_api/models/get_tips_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
+  # GetTipsRequest Model.
+  class GetTipsRequest < 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.
+      GetTipsRequest.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_tips_response.rb

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

data/lib/mindbody_public_api/models/get_transactions_request.rb

@@ -0,0 +1,173 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Transactions Request
+  class GetTransactionsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filters the transaction results with the ID number associated with the
+    # sale.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # Filters the transaction results with the ID number generated when the sale
+    # is processed.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # Filters results to the requested client ID.
+    # @return [Integer]
+    attr_accessor :client_id
+
+    # Filters the transaction results with the ID number associated with the
+    # location of the sale.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Filters the transaction results by the estimated transaction status.
+    # @return [String]
+    attr_accessor :status
+
+    # Filters the transaction results that happpened after this date and time. 
+    # Default: **today’s date**
+    # @return [DateTime]
+    attr_accessor :transaction_start_date_time
+
+    # Filters the transaction results that happpened before this date and time. 
+    # Default: **today’s date**
+    # @return [DateTime]
+    attr_accessor :transaction_end_date_time
+
+    # 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['sale_id'] = 'SaleId'
+      @_hash['transaction_id'] = 'TransactionId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['status'] = 'Status'
+      @_hash['transaction_start_date_time'] = 'TransactionStartDateTime'
+      @_hash['transaction_end_date_time'] = 'TransactionEndDateTime'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sale_id
+        transaction_id
+        client_id
+        location_id
+        status
+        transaction_start_date_time
+        transaction_end_date_time
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sale_id = SKIP, transaction_id = SKIP, client_id = SKIP,
+                   location_id = SKIP, status = SKIP,
+                   transaction_start_date_time = SKIP,
+                   transaction_end_date_time = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @sale_id = sale_id unless sale_id == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @status = status unless status == SKIP
+      unless transaction_start_date_time == SKIP
+        @transaction_start_date_time =
+          transaction_start_date_time
+      end
+      unless transaction_end_date_time == SKIP
+        @transaction_end_date_time =
+          transaction_end_date_time
+      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.
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      transaction_id = hash.key?('TransactionId') ? hash['TransactionId'] : SKIP
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      transaction_start_date_time = if hash.key?('TransactionStartDateTime')
+                                      (DateTimeHelper.from_rfc3339(hash['TransactionStartDateTime']) if hash['TransactionStartDateTime'])
+                                    else
+                                      SKIP
+                                    end
+      transaction_end_date_time = if hash.key?('TransactionEndDateTime')
+                                    (DateTimeHelper.from_rfc3339(hash['TransactionEndDateTime']) if hash['TransactionEndDateTime'])
+                                  else
+                                    SKIP
+                                  end
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetTransactionsRequest.new(sale_id,
+                                 transaction_id,
+                                 client_id,
+                                 location_id,
+                                 status,
+                                 transaction_start_date_time,
+                                 transaction_end_date_time,
+                                 limit,
+                                 offset)
+    end
+
+    def to_custom_transaction_start_date_time
+      DateTimeHelper.to_rfc3339(transaction_start_date_time)
+    end
+
+    def to_custom_transaction_end_date_time
+      DateTimeHelper.to_rfc3339(transaction_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} sale_id: #{@sale_id}, transaction_id: #{@transaction_id}, client_id:"\
+      " #{@client_id}, location_id: #{@location_id}, status: #{@status},"\
+      " transaction_start_date_time: #{@transaction_start_date_time}, transaction_end_date_time:"\
+      " #{@transaction_end_date_time}, 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} sale_id: #{@sale_id.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " client_id: #{@client_id.inspect}, location_id: #{@location_id.inspect}, status:"\
+      " #{@status.inspect}, transaction_start_date_time: #{@transaction_start_date_time.inspect},"\
+      " transaction_end_date_time: #{@transaction_end_date_time.inspect}, limit:"\
+      " #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_transactions_response.rb

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

data/lib/mindbody_public_api/models/get_unavailabilities_request.rb

@@ -0,0 +1,120 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetUnavailabilitiesRequest Model.
+  class GetUnavailabilitiesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of requested staff IDs.
+    # @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: **today’s date**
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # 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['start_date'] = 'StartDate'
+      @_hash['end_date'] = 'EndDate'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_ids
+        start_date
+        end_date
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_ids = SKIP, start_date = SKIP, end_date = SKIP,
+                   limit = SKIP, offset = 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
+      @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
+      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
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetUnavailabilitiesRequest.new(staff_ids,
+                                     start_date,
+                                     end_date,
+                                     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} staff_ids: #{@staff_ids}, start_date: #{@start_date}, end_date:"\
+      " #{@end_date}, 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}, start_date: #{@start_date.inspect},"\
+      " end_date: #{@end_date.inspect}, limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end