mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_client_duplicates_response.rb

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

data/lib/mindbody_public_api/models/get_client_formula_notes_request.rb

@@ -0,0 +1,93 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetClientFormulaNotesRequest Model.
+  class GetClientFormulaNotesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The client ID of the client whose formula notes are being requested.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The appointment ID of an appointment in the studio specified in the header
+    # of the request.
+    # @return [Integer]
+    attr_accessor :appointment_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['client_id'] = 'ClientId'
+      @_hash['appointment_id'] = 'AppointmentId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        appointment_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = SKIP, appointment_id = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @client_id = client_id unless client_id == SKIP
+      @appointment_id = appointment_id unless appointment_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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      appointment_id = hash.key?('AppointmentId') ? hash['AppointmentId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetClientFormulaNotesRequest.new(client_id,
+                                       appointment_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} client_id: #{@client_id}, appointment_id: #{@appointment_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} client_id: #{@client_id.inspect}, appointment_id:"\
+      " #{@appointment_id.inspect}, limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_client_formula_notes_response.rb

@@ -0,0 +1,85 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Enables to retrieve cross regional formula notes for a client, or for a
+  # specific appointment. The two parameters are optional, however at least one
+  # must be provided. This endpoint supports pagination.
+  class GetClientFormulaNotesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains information about the pagination to use.
+    # @return [PaginationResponse]
+    attr_accessor :pagination_response
+
+    # Contains details about the client’s formula.
+    # @return [Array[FormulaNoteResponse]]
+    attr_accessor :formula_notes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination_response'] = 'PaginationResponse'
+      @_hash['formula_notes'] = 'FormulaNotes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination_response
+        formula_notes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination_response = SKIP, formula_notes = SKIP)
+      @pagination_response = pagination_response unless pagination_response == SKIP
+      @formula_notes = formula_notes unless formula_notes == 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
+      formula_notes = nil
+      unless hash['FormulaNotes'].nil?
+        formula_notes = []
+        hash['FormulaNotes'].each do |structure|
+          formula_notes << (FormulaNoteResponse.from_hash(structure) if structure)
+        end
+      end
+
+      formula_notes = SKIP unless hash.key?('FormulaNotes')
+
+      # Create object from extracted values.
+      GetClientFormulaNotesResponse.new(pagination_response,
+                                        formula_notes)
+    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}, formula_notes:"\
+      " #{@formula_notes}>"
+    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}, formula_notes:"\
+      " #{@formula_notes.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_client_indexes_request.rb

@@ -0,0 +1,64 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetClientIndexesRequest Model.
+  class GetClientIndexesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, filters the results to only indexes that are required on
+    # creation.<br />
+    # When `false` or omitted, returns all of the client indexes.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :required_only
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['required_only'] = 'RequiredOnly'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        required_only
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(required_only = SKIP)
+      @required_only = required_only unless required_only == 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.
+      required_only = hash.key?('RequiredOnly') ? hash['RequiredOnly'] : SKIP
+
+      # Create object from extracted values.
+      GetClientIndexesRequest.new(required_only)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} required_only: #{@required_only}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} required_only: #{@required_only.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_client_indexes_response.rb

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

data/lib/mindbody_public_api/models/get_client_purchases_request.rb

@@ -0,0 +1,141 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetClientPurchasesRequest Model.
+  class GetClientPurchasesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client you are querying for purchases.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The unique ID of the requested client.
+    # @return [Integer]
+    attr_accessor :unique_client_id
+
+    # Filters results to purchases made on or after this timestamp.<br />
+    # Default: **now**
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # Filters results to purchases made before this timestamp.<br />
+    # Default: **end of today**
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # Filters results to the single record associated with this ID.
+    # @return [Integer]
+    attr_accessor :sale_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['client_id'] = 'ClientId'
+      @_hash['unique_client_id'] = 'UniqueClientId'
+      @_hash['start_date'] = 'StartDate'
+      @_hash['end_date'] = 'EndDate'
+      @_hash['sale_id'] = 'SaleId'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unique_client_id
+        start_date
+        end_date
+        sale_id
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, unique_client_id = SKIP, start_date = SKIP,
+                   end_date = SKIP, sale_id = SKIP, limit = SKIP, offset = SKIP)
+      @client_id = client_id
+      @unique_client_id = unique_client_id unless unique_client_id == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @sale_id = sale_id unless sale_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.
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      unique_client_id =
+        hash.key?('UniqueClientId') ? hash['UniqueClientId'] : 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
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetClientPurchasesRequest.new(client_id,
+                                    unique_client_id,
+                                    start_date,
+                                    end_date,
+                                    sale_id,
+                                    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} client_id: #{@client_id}, unique_client_id: #{@unique_client_id},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, sale_id: #{@sale_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} client_id: #{@client_id.inspect}, unique_client_id:"\
+      " #{@unique_client_id.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, sale_id: #{@sale_id.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_client_purchases_response.rb

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

data/lib/mindbody_public_api/models/get_client_referral_types_request.rb

@@ -0,0 +1,66 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetClientReferralTypesRequest Model.
+  class GetClientReferralTypesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When `true`, filters the results to include subtypes and inactive referral
+    # types.<br />
+    # When `false`, includes no subtypes and only active types.
+    # Default:**false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_inactive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['include_inactive'] = 'IncludeInactive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_inactive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(include_inactive = SKIP)
+      @include_inactive = include_inactive unless include_inactive == 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.
+      include_inactive =
+        hash.key?('IncludeInactive') ? hash['IncludeInactive'] : SKIP
+
+      # Create object from extracted values.
+      GetClientReferralTypesRequest.new(include_inactive)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} include_inactive: #{@include_inactive}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} include_inactive: #{@include_inactive.inspect}>"
+    end
+  end
+end