mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_sales_reps_response.rb

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

data/lib/mindbody_public_api/models/get_sales_request.rb

@@ -0,0 +1,134 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetSalesRequest Model.
+  class GetSalesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The sale ID associated with the particular item. It Filters results to the
+    # requested sale ID.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # Filters results to sales that happened after this date and time.
+    # @return [DateTime]
+    attr_accessor :start_sale_date_time
+
+    # Filters results to sales that happened before this date and time.
+    # @return [DateTime]
+    attr_accessor :end_sale_date_time
+
+    # Filters results to sales paid for by the given payment method ID which
+    # indicates payment method(s) (i.e. cash, VISA, AMEX, Check, etc.).
+    # @return [Integer]
+    attr_accessor :payment_method_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['sale_id'] = 'SaleId'
+      @_hash['start_sale_date_time'] = 'StartSaleDateTime'
+      @_hash['end_sale_date_time'] = 'EndSaleDateTime'
+      @_hash['payment_method_id'] = 'PaymentMethodId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sale_id
+        start_sale_date_time
+        end_sale_date_time
+        payment_method_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sale_id = SKIP, start_sale_date_time = SKIP,
+                   end_sale_date_time = SKIP, payment_method_id = SKIP,
+                   limit = SKIP, offset = SKIP)
+      @sale_id = sale_id unless sale_id == SKIP
+      @start_sale_date_time = start_sale_date_time unless start_sale_date_time == SKIP
+      @end_sale_date_time = end_sale_date_time unless end_sale_date_time == SKIP
+      @payment_method_id = payment_method_id unless payment_method_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.
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      start_sale_date_time = if hash.key?('StartSaleDateTime')
+                               (DateTimeHelper.from_rfc3339(hash['StartSaleDateTime']) if hash['StartSaleDateTime'])
+                             else
+                               SKIP
+                             end
+      end_sale_date_time = if hash.key?('EndSaleDateTime')
+                             (DateTimeHelper.from_rfc3339(hash['EndSaleDateTime']) if hash['EndSaleDateTime'])
+                           else
+                             SKIP
+                           end
+      payment_method_id =
+        hash.key?('PaymentMethodId') ? hash['PaymentMethodId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetSalesRequest.new(sale_id,
+                          start_sale_date_time,
+                          end_sale_date_time,
+                          payment_method_id,
+                          limit,
+                          offset)
+    end
+
+    def to_custom_start_sale_date_time
+      DateTimeHelper.to_rfc3339(start_sale_date_time)
+    end
+
+    def to_custom_end_sale_date_time
+      DateTimeHelper.to_rfc3339(end_sale_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}, start_sale_date_time: #{@start_sale_date_time},"\
+      " end_sale_date_time: #{@end_sale_date_time}, payment_method_id: #{@payment_method_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} sale_id: #{@sale_id.inspect}, start_sale_date_time:"\
+      " #{@start_sale_date_time.inspect}, end_sale_date_time: #{@end_sale_date_time.inspect},"\
+      " payment_method_id: #{@payment_method_id.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_sales_response.rb

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

data/lib/mindbody_public_api/models/get_schedule_items_request.rb

@@ -0,0 +1,145 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetScheduleItemsRequest Model.
+  class GetScheduleItemsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of requested location IDs.
+    # @return [Array[Integer]]
+    attr_accessor :location_ids
+
+    # 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
+
+    # When `true`, appointment preparation and finish unavailabilities are not
+    # returned. 
+    # <br />Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :ignore_prep_finish_times
+
+    # 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['location_ids'] = 'LocationIds'
+      @_hash['staff_ids'] = 'StaffIds'
+      @_hash['start_date'] = 'StartDate'
+      @_hash['end_date'] = 'EndDate'
+      @_hash['ignore_prep_finish_times'] = 'IgnorePrepFinishTimes'
+      @_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
+        ignore_prep_finish_times
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(location_ids = SKIP, staff_ids = SKIP, start_date = SKIP,
+                   end_date = SKIP, ignore_prep_finish_times = SKIP,
+                   limit = SKIP, offset = SKIP)
+      @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
+      @ignore_prep_finish_times = ignore_prep_finish_times unless ignore_prep_finish_times == 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.
+      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
+      ignore_prep_finish_times =
+        hash.key?('IgnorePrepFinishTimes') ? hash['IgnorePrepFinishTimes'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetScheduleItemsRequest.new(location_ids,
+                                  staff_ids,
+                                  start_date,
+                                  end_date,
+                                  ignore_prep_finish_times,
+                                  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} location_ids: #{@location_ids}, staff_ids: #{@staff_ids}, start_date:"\
+      " #{@start_date}, end_date: #{@end_date}, ignore_prep_finish_times:"\
+      " #{@ignore_prep_finish_times}, 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} location_ids: #{@location_ids.inspect}, staff_ids: #{@staff_ids.inspect},"\
+      " start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " ignore_prep_finish_times: #{@ignore_prep_finish_times.inspect}, limit: #{@limit.inspect},"\
+      " offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_schedule_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
+  # GetScheduleItemsResponse Model.
+  class GetScheduleItemsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the pagination to use.
+    # @return [PaginationResponse]
+    attr_accessor :pagination_response
+
+    # Contains information about staff members with schedule items.
+    # @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.
+      GetScheduleItemsResponse.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_scheduled_service_earnings_request.rb

@@ -0,0 +1,172 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetScheduledServiceEarningsRequest Model.
+  class GetScheduledServiceEarningsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filters the results to schedule service earnings for specific types of
+    # services. Possible values:
+    # * Class
+    # * Appointment
+    # @return [String]
+    attr_accessor :scheduled_service_type
+
+    # Filters the results to a single scheduled service. This parameter must be
+    # used with a single ScheduledServiceType.
+    # @return [Integer]
+    attr_accessor :scheduled_service_id
+
+    # 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['scheduled_service_type'] = 'ScheduledServiceType'
+      @_hash['scheduled_service_id'] = 'ScheduledServiceId'
+      @_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[
+        scheduled_service_type
+        scheduled_service_id
+        staff_id
+        start_date_time
+        end_date_time
+        location_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheduled_service_type = SKIP, scheduled_service_id = SKIP,
+                   staff_id = SKIP, start_date_time = SKIP,
+                   end_date_time = SKIP, location_id = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @scheduled_service_type = scheduled_service_type unless scheduled_service_type == SKIP
+      @scheduled_service_id = scheduled_service_id unless scheduled_service_id == 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.
+      scheduled_service_type =
+        hash.key?('ScheduledServiceType') ? hash['ScheduledServiceType'] : SKIP
+      scheduled_service_id =
+        hash.key?('ScheduledServiceId') ? hash['ScheduledServiceId'] : SKIP
+      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.
+      GetScheduledServiceEarningsRequest.new(scheduled_service_type,
+                                             scheduled_service_id,
+                                             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} scheduled_service_type: #{@scheduled_service_type}, scheduled_service_id:"\
+      " #{@scheduled_service_id}, 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} scheduled_service_type: #{@scheduled_service_type.inspect},"\
+      " scheduled_service_id: #{@scheduled_service_id.inspect}, 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