mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/terminate_contract_request.rb

@@ -0,0 +1,113 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # TerminateContractRequest Model.
+  class TerminateContractRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The unique ID of the sale of the contract
+    # @return [Integer]
+    attr_accessor :client_contract_id
+
+    # The contract termination date.
+    # @return [DateTime]
+    attr_accessor :termination_date
+
+    # ex. Illness, Injury, Moving, BreakingContract (Note this can be customized
+    # by each studio).
+    # @return [String]
+    attr_accessor :termination_code
+
+    # The comments for terminating a contract.
+    # @return [String]
+    attr_accessor :termination_comments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'ClientId'
+      @_hash['client_contract_id'] = 'ClientContractId'
+      @_hash['termination_date'] = 'TerminationDate'
+      @_hash['termination_code'] = 'TerminationCode'
+      @_hash['termination_comments'] = 'TerminationComments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        termination_code
+        termination_comments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, client_contract_id = nil,
+                   termination_date = nil, termination_code = SKIP,
+                   termination_comments = SKIP)
+      @client_id = client_id
+      @client_contract_id = client_contract_id
+      @termination_date = termination_date
+      @termination_code = termination_code unless termination_code == SKIP
+      @termination_comments = termination_comments unless termination_comments == 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
+      client_contract_id =
+        hash.key?('ClientContractId') ? hash['ClientContractId'] : nil
+      termination_date = if hash.key?('TerminationDate')
+                           (DateTimeHelper.from_rfc3339(hash['TerminationDate']) if hash['TerminationDate'])
+                         end
+      termination_code =
+        hash.key?('TerminationCode') ? hash['TerminationCode'] : SKIP
+      termination_comments =
+        hash.key?('TerminationComments') ? hash['TerminationComments'] : SKIP
+
+      # Create object from extracted values.
+      TerminateContractRequest.new(client_id,
+                                   client_contract_id,
+                                   termination_date,
+                                   termination_code,
+                                   termination_comments)
+    end
+
+    def to_custom_termination_date
+      DateTimeHelper.to_rfc3339(termination_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}, client_contract_id: #{@client_contract_id},"\
+      " termination_date: #{@termination_date}, termination_code: #{@termination_code},"\
+      " termination_comments: #{@termination_comments}>"
+    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}, client_contract_id:"\
+      " #{@client_contract_id.inspect}, termination_date: #{@termination_date.inspect},"\
+      " termination_code: #{@termination_code.inspect}, termination_comments:"\
+      " #{@termination_comments.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/terminate_contract_response.rb

@@ -0,0 +1,62 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # TerminateContractResponse Model.
+  class TerminateContractResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A client contract.
+    # @return [ClientContract]
+    attr_accessor :contract
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contract'] = 'Contract'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contract
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(contract = SKIP)
+      @contract = contract unless contract == 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.
+      contract = ClientContract.from_hash(hash['Contract']) if hash['Contract']
+
+      # Create object from extracted values.
+      TerminateContractResponse.new(contract)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} contract: #{@contract.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/time_card_event.rb

@@ -0,0 +1,139 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # TimeCardEvent Model.
+  class TimeCardEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the requested staff member.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The staff member’s job title.
+    # @return [String]
+    attr_accessor :task
+
+    # The time that the staff member started the job task.
+    # @return [DateTime]
+    attr_accessor :time_in
+
+    # The time that the staff member stopped doing the job task.
+    # @return [DateTime]
+    attr_accessor :time_out
+
+    # The number of hours on this time card, rounded to the nearest fourth
+    # decimal place.
+    # @return [Float]
+    attr_accessor :hours
+
+    # The hourly rate the business pays this staff for this `Task`.
+    # @return [Float]
+    attr_accessor :hourly_rate
+
+    # The total amount earned by the staff member for this time card entry.
+    # @return [Float]
+    attr_accessor :earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['task'] = 'Task'
+      @_hash['time_in'] = 'TimeIn'
+      @_hash['time_out'] = 'TimeOut'
+      @_hash['hours'] = 'Hours'
+      @_hash['hourly_rate'] = 'HourlyRate'
+      @_hash['earnings'] = 'Earnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        task
+        time_in
+        time_out
+        hours
+        hourly_rate
+        earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, task = SKIP, time_in = SKIP,
+                   time_out = SKIP, hours = SKIP, hourly_rate = SKIP,
+                   earnings = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @task = task unless task == SKIP
+      @time_in = time_in unless time_in == SKIP
+      @time_out = time_out unless time_out == SKIP
+      @hours = hours unless hours == SKIP
+      @hourly_rate = hourly_rate unless hourly_rate == SKIP
+      @earnings = earnings unless earnings == 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
+      task = hash.key?('Task') ? hash['Task'] : SKIP
+      time_in = if hash.key?('TimeIn')
+                  (DateTimeHelper.from_rfc3339(hash['TimeIn']) if hash['TimeIn'])
+                else
+                  SKIP
+                end
+      time_out = if hash.key?('TimeOut')
+                   (DateTimeHelper.from_rfc3339(hash['TimeOut']) if hash['TimeOut'])
+                 else
+                   SKIP
+                 end
+      hours = hash.key?('Hours') ? hash['Hours'] : SKIP
+      hourly_rate = hash.key?('HourlyRate') ? hash['HourlyRate'] : SKIP
+      earnings = hash.key?('Earnings') ? hash['Earnings'] : SKIP
+
+      # Create object from extracted values.
+      TimeCardEvent.new(staff_id,
+                        task,
+                        time_in,
+                        time_out,
+                        hours,
+                        hourly_rate,
+                        earnings)
+    end
+
+    def to_custom_time_in
+      DateTimeHelper.to_rfc3339(time_in)
+    end
+
+    def to_custom_time_out
+      DateTimeHelper.to_rfc3339(time_out)
+    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}, task: #{@task}, time_in: #{@time_in}, time_out:"\
+      " #{@time_out}, hours: #{@hours}, hourly_rate: #{@hourly_rate}, earnings: #{@earnings}>"
+    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}, task: #{@task.inspect}, time_in:"\
+      " #{@time_in.inspect}, time_out: #{@time_out.inspect}, hours: #{@hours.inspect},"\
+      " hourly_rate: #{@hourly_rate.inspect}, earnings: #{@earnings.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/tip.rb

@@ -0,0 +1,101 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Tip Model.
+  class Tip < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the staff member the tip is for.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The sale’s ID associated with the tip.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # The date and time when the tip was given.
+    # @return [DateTime]
+    attr_accessor :sale_date_time
+
+    # The amount tipped to the staff member.
+    # @return [Float]
+    attr_accessor :earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['staff_id'] = 'StaffId'
+      @_hash['sale_id'] = 'SaleId'
+      @_hash['sale_date_time'] = 'SaleDateTime'
+      @_hash['earnings'] = 'Earnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        sale_id
+        sale_date_time
+        earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, sale_id = SKIP, sale_date_time = SKIP,
+                   earnings = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @sale_id = sale_id unless sale_id == SKIP
+      @sale_date_time = sale_date_time unless sale_date_time == SKIP
+      @earnings = earnings unless earnings == 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
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      sale_date_time = if hash.key?('SaleDateTime')
+                         (DateTimeHelper.from_rfc3339(hash['SaleDateTime']) if hash['SaleDateTime'])
+                       else
+                         SKIP
+                       end
+      earnings = hash.key?('Earnings') ? hash['Earnings'] : SKIP
+
+      # Create object from extracted values.
+      Tip.new(staff_id,
+              sale_id,
+              sale_date_time,
+              earnings)
+    end
+
+    def to_custom_sale_date_time
+      DateTimeHelper.to_rfc3339(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} staff_id: #{@staff_id}, sale_id: #{@sale_id}, sale_date_time:"\
+      " #{@sale_date_time}, earnings: #{@earnings}>"
+    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}, sale_id: #{@sale_id.inspect},"\
+      " sale_date_time: #{@sale_date_time.inspect}, earnings: #{@earnings.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/transaction.rb

@@ -0,0 +1,245 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # Transaction Model.
+  class Transaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction ID.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # The sale ID.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # The ID of the client who made the purchase.
+    # @return [Integer]
+    attr_accessor :client_id
+
+    # The amount charged on the card
+    # @return [Float]
+    attr_accessor :amount
+
+    # Whether it is settled or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :settled
+
+    # Status of the transaction
+    # @return [String]
+    attr_accessor :status
+
+    # Time of card swiped
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # Time of card authorized
+    # @return [DateTime]
+    attr_accessor :auth_time
+
+    # The ID of the location where the sale takes place.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Merchant ID of the studio
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Terminal ID used for payment. Not applicable for CNP/Bank
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # Expiry month of the card
+    # @return [String]
+    attr_accessor :card_expiration_month
+
+    # Expiry year of the card
+    # @return [String]
+    attr_accessor :card_expiration_year
+
+    # Last 4 digits of CC
+    # @return [String]
+    attr_accessor :cc_last_four
+
+    # Type of the card
+    # @return [String]
+    attr_accessor :card_type
+
+    # Whether card is swiped or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cc_swiped
+
+    # Customer’s ACH last 4 digits
+    # @return [String]
+    attr_accessor :ach_last_four
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'TransactionId'
+      @_hash['sale_id'] = 'SaleId'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['amount'] = 'Amount'
+      @_hash['settled'] = 'Settled'
+      @_hash['status'] = 'Status'
+      @_hash['transaction_time'] = 'TransactionTime'
+      @_hash['auth_time'] = 'AuthTime'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['merchant_id'] = 'MerchantId'
+      @_hash['terminal_id'] = 'TerminalId'
+      @_hash['card_expiration_month'] = 'CardExpirationMonth'
+      @_hash['card_expiration_year'] = 'CardExpirationYear'
+      @_hash['cc_last_four'] = 'CCLastFour'
+      @_hash['card_type'] = 'CardType'
+      @_hash['cc_swiped'] = 'CCSwiped'
+      @_hash['ach_last_four'] = 'ACHLastFour'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        sale_id
+        client_id
+        amount
+        settled
+        status
+        transaction_time
+        auth_time
+        location_id
+        merchant_id
+        terminal_id
+        card_expiration_month
+        card_expiration_year
+        cc_last_four
+        card_type
+        cc_swiped
+        ach_last_four
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP, sale_id = SKIP, client_id = SKIP,
+                   amount = SKIP, settled = SKIP, status = SKIP,
+                   transaction_time = SKIP, auth_time = SKIP,
+                   location_id = SKIP, merchant_id = SKIP, terminal_id = SKIP,
+                   card_expiration_month = SKIP, card_expiration_year = SKIP,
+                   cc_last_four = SKIP, card_type = SKIP, cc_swiped = SKIP,
+                   ach_last_four = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @sale_id = sale_id unless sale_id == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @amount = amount unless amount == SKIP
+      @settled = settled unless settled == SKIP
+      @status = status unless status == SKIP
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @auth_time = auth_time unless auth_time == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @terminal_id = terminal_id unless terminal_id == SKIP
+      @card_expiration_month = card_expiration_month unless card_expiration_month == SKIP
+      @card_expiration_year = card_expiration_year unless card_expiration_year == SKIP
+      @cc_last_four = cc_last_four unless cc_last_four == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @cc_swiped = cc_swiped unless cc_swiped == SKIP
+      @ach_last_four = ach_last_four unless ach_last_four == 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.
+      transaction_id = hash.key?('TransactionId') ? hash['TransactionId'] : SKIP
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      amount = hash.key?('Amount') ? hash['Amount'] : SKIP
+      settled = hash.key?('Settled') ? hash['Settled'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      transaction_time = if hash.key?('TransactionTime')
+                           (DateTimeHelper.from_rfc3339(hash['TransactionTime']) if hash['TransactionTime'])
+                         else
+                           SKIP
+                         end
+      auth_time = if hash.key?('AuthTime')
+                    (DateTimeHelper.from_rfc3339(hash['AuthTime']) if hash['AuthTime'])
+                  else
+                    SKIP
+                  end
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      merchant_id = hash.key?('MerchantId') ? hash['MerchantId'] : SKIP
+      terminal_id = hash.key?('TerminalId') ? hash['TerminalId'] : SKIP
+      card_expiration_month =
+        hash.key?('CardExpirationMonth') ? hash['CardExpirationMonth'] : SKIP
+      card_expiration_year =
+        hash.key?('CardExpirationYear') ? hash['CardExpirationYear'] : SKIP
+      cc_last_four = hash.key?('CCLastFour') ? hash['CCLastFour'] : SKIP
+      card_type = hash.key?('CardType') ? hash['CardType'] : SKIP
+      cc_swiped = hash.key?('CCSwiped') ? hash['CCSwiped'] : SKIP
+      ach_last_four = hash.key?('ACHLastFour') ? hash['ACHLastFour'] : SKIP
+
+      # Create object from extracted values.
+      Transaction.new(transaction_id,
+                      sale_id,
+                      client_id,
+                      amount,
+                      settled,
+                      status,
+                      transaction_time,
+                      auth_time,
+                      location_id,
+                      merchant_id,
+                      terminal_id,
+                      card_expiration_month,
+                      card_expiration_year,
+                      cc_last_four,
+                      card_type,
+                      cc_swiped,
+                      ach_last_four)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    def to_custom_auth_time
+      DateTimeHelper.to_rfc3339(auth_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id}, sale_id: #{@sale_id}, client_id:"\
+      " #{@client_id}, amount: #{@amount}, settled: #{@settled}, status: #{@status},"\
+      " transaction_time: #{@transaction_time}, auth_time: #{@auth_time}, location_id:"\
+      " #{@location_id}, merchant_id: #{@merchant_id}, terminal_id: #{@terminal_id},"\
+      " card_expiration_month: #{@card_expiration_month}, card_expiration_year:"\
+      " #{@card_expiration_year}, cc_last_four: #{@cc_last_four}, card_type: #{@card_type},"\
+      " cc_swiped: #{@cc_swiped}, ach_last_four: #{@ach_last_four}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_id: #{@transaction_id.inspect}, sale_id: #{@sale_id.inspect},"\
+      " client_id: #{@client_id.inspect}, amount: #{@amount.inspect}, settled:"\
+      " #{@settled.inspect}, status: #{@status.inspect}, transaction_time:"\
+      " #{@transaction_time.inspect}, auth_time: #{@auth_time.inspect}, location_id:"\
+      " #{@location_id.inspect}, merchant_id: #{@merchant_id.inspect}, terminal_id:"\
+      " #{@terminal_id.inspect}, card_expiration_month: #{@card_expiration_month.inspect},"\
+      " card_expiration_year: #{@card_expiration_year.inspect}, cc_last_four:"\
+      " #{@cc_last_four.inspect}, card_type: #{@card_type.inspect}, cc_swiped:"\
+      " #{@cc_swiped.inspect}, ach_last_four: #{@ach_last_four.inspect}>"
+    end
+  end
+end