mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/purchased_item.rb

@@ -0,0 +1,337 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # PurchasedItem Model.
+  class PurchasedItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID which gets assigned to the item when item is added to the cart.
+    # @return [Integer]
+    attr_accessor :sale_detail_id
+
+    # The ID of the purchased item. Use this ID when calling the GET Services or
+    # GET Products endpoint.
+    # @return [Integer]
+    attr_accessor :id
+
+    # When `true`, indicates that the purchased item was a pricing option for a
+    # service.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_service
+
+    # The barcode number of the purchased item. Use this ID when calling the GET
+    # Products endpoint.
+    # @return [String]
+    attr_accessor :barcode_id
+
+    # The description of the sale transaction/pricing option.
+    # @return [String]
+    attr_accessor :description
+
+    # The contract purchased by the client. Use this ID when calling the GET
+    # Contract endpoint.
+    # @return [Integer]
+    attr_accessor :contract_id
+
+    # The revenue category ID used for sale. Use this ID when calling the GET
+    # Categories endpoint.
+    # @return [Integer]
+    attr_accessor :category_id
+
+    # The ID of revenue subcategory.
+    # @return [Integer]
+    attr_accessor :sub_category_id
+
+    # er Unit Price of the item purchased.
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # Quantity of the purchased item, applicable for products only. Note:
+    # Negative numbers indicate returned items.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The percent discount that was applied to the items subtotal.
+    # @return [Float]
+    attr_accessor :discount_percent
+
+    # The total discount amount that was applied to the items subtotal.
+    # @return [Float]
+    attr_accessor :discount_amount
+
+    # A decimal representation of the first tax rate that was applied to the
+    # items subtotal.
+    # @return [Float]
+    attr_accessor :tax1
+
+    # A decimal representation of the second tax rate that was applied to the
+    # items subtotal.
+    # @return [Float]
+    attr_accessor :tax2
+
+    # A decimal representation of the third tax rate that was applied to the
+    # items subtotal.
+    # @return [Float]
+    attr_accessor :tax3
+
+    # A decimal representation of the fourth tax rate that was applied to the
+    # items subtotal.
+    # @return [Float]
+    attr_accessor :tax4
+
+    # A decimal representation of the fifth tax rate that was applied to the
+    # items subtotal.
+    # @return [Float]
+    attr_accessor :tax5
+
+    # Total tax amount that is summation of tax1, tax2, tax3, tax4 and tax5.
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # The items total, once discounts and/or tax was applied.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Note made by the customer while purchasing item.
+    # @return [String]
+    attr_accessor :notes
+
+    # When `true`, indicates that the purchased item is returned, `false`
+    # otherwise.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :returned
+
+    # The payment reference ID generated during payment of sold item.
+    # @return [Integer]
+    attr_accessor :payment_ref_id
+
+    # The expiration date of the pricing option purchased.
+    # @return [DateTime]
+    attr_accessor :exp_date
+
+    # The activation date of pricing option purchased.
+    # @return [DateTime]
+    attr_accessor :active_date
+
+    # Gift Card BarcodeId
+    # @return [String]
+    attr_accessor :gift_card_barcode_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sale_detail_id'] = 'SaleDetailId'
+      @_hash['id'] = 'Id'
+      @_hash['is_service'] = 'IsService'
+      @_hash['barcode_id'] = 'BarcodeId'
+      @_hash['description'] = 'Description'
+      @_hash['contract_id'] = 'ContractId'
+      @_hash['category_id'] = 'CategoryId'
+      @_hash['sub_category_id'] = 'SubCategoryId'
+      @_hash['unit_price'] = 'UnitPrice'
+      @_hash['quantity'] = 'Quantity'
+      @_hash['discount_percent'] = 'DiscountPercent'
+      @_hash['discount_amount'] = 'DiscountAmount'
+      @_hash['tax1'] = 'Tax1'
+      @_hash['tax2'] = 'Tax2'
+      @_hash['tax3'] = 'Tax3'
+      @_hash['tax4'] = 'Tax4'
+      @_hash['tax5'] = 'Tax5'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['total_amount'] = 'TotalAmount'
+      @_hash['notes'] = 'Notes'
+      @_hash['returned'] = 'Returned'
+      @_hash['payment_ref_id'] = 'PaymentRefId'
+      @_hash['exp_date'] = 'ExpDate'
+      @_hash['active_date'] = 'ActiveDate'
+      @_hash['gift_card_barcode_id'] = 'GiftCardBarcodeId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sale_detail_id
+        id
+        is_service
+        barcode_id
+        description
+        contract_id
+        category_id
+        sub_category_id
+        unit_price
+        quantity
+        discount_percent
+        discount_amount
+        tax1
+        tax2
+        tax3
+        tax4
+        tax5
+        tax_amount
+        total_amount
+        notes
+        returned
+        payment_ref_id
+        exp_date
+        active_date
+        gift_card_barcode_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sale_detail_id = SKIP, id = SKIP, is_service = SKIP,
+                   barcode_id = SKIP, description = SKIP, contract_id = SKIP,
+                   category_id = SKIP, sub_category_id = SKIP,
+                   unit_price = SKIP, quantity = SKIP, discount_percent = SKIP,
+                   discount_amount = SKIP, tax1 = SKIP, tax2 = SKIP,
+                   tax3 = SKIP, tax4 = SKIP, tax5 = SKIP, tax_amount = SKIP,
+                   total_amount = SKIP, notes = SKIP, returned = SKIP,
+                   payment_ref_id = SKIP, exp_date = SKIP, active_date = SKIP,
+                   gift_card_barcode_id = SKIP)
+      @sale_detail_id = sale_detail_id unless sale_detail_id == SKIP
+      @id = id unless id == SKIP
+      @is_service = is_service unless is_service == SKIP
+      @barcode_id = barcode_id unless barcode_id == SKIP
+      @description = description unless description == SKIP
+      @contract_id = contract_id unless contract_id == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @sub_category_id = sub_category_id unless sub_category_id == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @discount_percent = discount_percent unless discount_percent == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @tax1 = tax1 unless tax1 == SKIP
+      @tax2 = tax2 unless tax2 == SKIP
+      @tax3 = tax3 unless tax3 == SKIP
+      @tax4 = tax4 unless tax4 == SKIP
+      @tax5 = tax5 unless tax5 == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @notes = notes unless notes == SKIP
+      @returned = returned unless returned == SKIP
+      @payment_ref_id = payment_ref_id unless payment_ref_id == SKIP
+      @exp_date = exp_date unless exp_date == SKIP
+      @active_date = active_date unless active_date == SKIP
+      @gift_card_barcode_id = gift_card_barcode_id unless gift_card_barcode_id == 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_detail_id = hash.key?('SaleDetailId') ? hash['SaleDetailId'] : SKIP
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      is_service = hash.key?('IsService') ? hash['IsService'] : SKIP
+      barcode_id = hash.key?('BarcodeId') ? hash['BarcodeId'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      contract_id = hash.key?('ContractId') ? hash['ContractId'] : SKIP
+      category_id = hash.key?('CategoryId') ? hash['CategoryId'] : SKIP
+      sub_category_id =
+        hash.key?('SubCategoryId') ? hash['SubCategoryId'] : SKIP
+      unit_price = hash.key?('UnitPrice') ? hash['UnitPrice'] : SKIP
+      quantity = hash.key?('Quantity') ? hash['Quantity'] : SKIP
+      discount_percent =
+        hash.key?('DiscountPercent') ? hash['DiscountPercent'] : SKIP
+      discount_amount =
+        hash.key?('DiscountAmount') ? hash['DiscountAmount'] : SKIP
+      tax1 = hash.key?('Tax1') ? hash['Tax1'] : SKIP
+      tax2 = hash.key?('Tax2') ? hash['Tax2'] : SKIP
+      tax3 = hash.key?('Tax3') ? hash['Tax3'] : SKIP
+      tax4 = hash.key?('Tax4') ? hash['Tax4'] : SKIP
+      tax5 = hash.key?('Tax5') ? hash['Tax5'] : SKIP
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      total_amount = hash.key?('TotalAmount') ? hash['TotalAmount'] : SKIP
+      notes = hash.key?('Notes') ? hash['Notes'] : SKIP
+      returned = hash.key?('Returned') ? hash['Returned'] : SKIP
+      payment_ref_id = hash.key?('PaymentRefId') ? hash['PaymentRefId'] : SKIP
+      exp_date = if hash.key?('ExpDate')
+                   (DateTimeHelper.from_rfc3339(hash['ExpDate']) if hash['ExpDate'])
+                 else
+                   SKIP
+                 end
+      active_date = if hash.key?('ActiveDate')
+                      (DateTimeHelper.from_rfc3339(hash['ActiveDate']) if hash['ActiveDate'])
+                    else
+                      SKIP
+                    end
+      gift_card_barcode_id =
+        hash.key?('GiftCardBarcodeId') ? hash['GiftCardBarcodeId'] : SKIP
+
+      # Create object from extracted values.
+      PurchasedItem.new(sale_detail_id,
+                        id,
+                        is_service,
+                        barcode_id,
+                        description,
+                        contract_id,
+                        category_id,
+                        sub_category_id,
+                        unit_price,
+                        quantity,
+                        discount_percent,
+                        discount_amount,
+                        tax1,
+                        tax2,
+                        tax3,
+                        tax4,
+                        tax5,
+                        tax_amount,
+                        total_amount,
+                        notes,
+                        returned,
+                        payment_ref_id,
+                        exp_date,
+                        active_date,
+                        gift_card_barcode_id)
+    end
+
+    def to_custom_exp_date
+      DateTimeHelper.to_rfc3339(exp_date)
+    end
+
+    def to_custom_active_date
+      DateTimeHelper.to_rfc3339(active_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sale_detail_id: #{@sale_detail_id}, id: #{@id}, is_service: #{@is_service},"\
+      " barcode_id: #{@barcode_id}, description: #{@description}, contract_id: #{@contract_id},"\
+      " category_id: #{@category_id}, sub_category_id: #{@sub_category_id}, unit_price:"\
+      " #{@unit_price}, quantity: #{@quantity}, discount_percent: #{@discount_percent},"\
+      " discount_amount: #{@discount_amount}, tax1: #{@tax1}, tax2: #{@tax2}, tax3: #{@tax3},"\
+      " tax4: #{@tax4}, tax5: #{@tax5}, tax_amount: #{@tax_amount}, total_amount:"\
+      " #{@total_amount}, notes: #{@notes}, returned: #{@returned}, payment_ref_id:"\
+      " #{@payment_ref_id}, exp_date: #{@exp_date}, active_date: #{@active_date},"\
+      " gift_card_barcode_id: #{@gift_card_barcode_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sale_detail_id: #{@sale_detail_id.inspect}, id: #{@id.inspect}, is_service:"\
+      " #{@is_service.inspect}, barcode_id: #{@barcode_id.inspect}, description:"\
+      " #{@description.inspect}, contract_id: #{@contract_id.inspect}, category_id:"\
+      " #{@category_id.inspect}, sub_category_id: #{@sub_category_id.inspect}, unit_price:"\
+      " #{@unit_price.inspect}, quantity: #{@quantity.inspect}, discount_percent:"\
+      " #{@discount_percent.inspect}, discount_amount: #{@discount_amount.inspect}, tax1:"\
+      " #{@tax1.inspect}, tax2: #{@tax2.inspect}, tax3: #{@tax3.inspect}, tax4: #{@tax4.inspect},"\
+      " tax5: #{@tax5.inspect}, tax_amount: #{@tax_amount.inspect}, total_amount:"\
+      " #{@total_amount.inspect}, notes: #{@notes.inspect}, returned: #{@returned.inspect},"\
+      " payment_ref_id: #{@payment_ref_id.inspect}, exp_date: #{@exp_date.inspect}, active_date:"\
+      " #{@active_date.inspect}, gift_card_barcode_id: #{@gift_card_barcode_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/relationship.rb

@@ -0,0 +1,85 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # Jim is a RelationshipName1 of John. John is a RelationshipName2 of Jim.
+  class Relationship < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the relationship.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The name of the first relationship.
+    # @return [String]
+    attr_accessor :relationship_name1
+
+    # The name of the second relationship.
+    # @return [String]
+    attr_accessor :relationship_name2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['relationship_name1'] = 'RelationshipName1'
+      @_hash['relationship_name2'] = 'RelationshipName2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        relationship_name1
+        relationship_name2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, relationship_name1 = SKIP,
+                   relationship_name2 = SKIP)
+      @id = id unless id == SKIP
+      @relationship_name1 = relationship_name1 unless relationship_name1 == SKIP
+      @relationship_name2 = relationship_name2 unless relationship_name2 == 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.
+      id = hash.key?('Id') ? hash['Id'] : SKIP
+      relationship_name1 =
+        hash.key?('RelationshipName1') ? hash['RelationshipName1'] : SKIP
+      relationship_name2 =
+        hash.key?('RelationshipName2') ? hash['RelationshipName2'] : SKIP
+
+      # Create object from extracted values.
+      Relationship.new(id,
+                       relationship_name1,
+                       relationship_name2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, relationship_name1: #{@relationship_name1}, relationship_name2:"\
+      " #{@relationship_name2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, relationship_name1: #{@relationship_name1.inspect},"\
+      " relationship_name2: #{@relationship_name2.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/remove_client_from_class_request.rb

@@ -0,0 +1,142 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # RemoveClientFromClassRequest Model.
+  class RemoveClientFromClassRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The RSSID of the client to remove from the specified class.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The Unique Id of the client to remove from the specified class
+    # Note: you need to provide the 'UniqueClientId' OR the 'ClientId'. If both
+    # are provided, the 'UniqueClientId' takes precedence.
+    # @return [Integer]
+    attr_accessor :unique_client_id
+
+    # The ID of the class that you want to remove the client from.
+    # @return [Integer]
+    attr_accessor :class_id
+
+    # When `true`, the request ensures that its parameters are valid without
+    # affecting real data.<br />
+    # When `false`, the request performs as intended and may affect live client
+    # data.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # When `true`, indicates that the client should be sent an email. Depending
+    # on the site and client settings, an email may or may not be sent.<br />
+    # Default: **false**
+    # Note: When the Authorization header is passed and the SendEmail is set to
+    # `true`, then an email will be sent.
+    # When the Authorization header is passed and the SendEmail is set to
+    # `false`, then an email will not be sent.
+    # When the Authorization header is not passed and the SendEmail is set to
+    # either `true` or `false`, then an email will not be sent.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_email
+
+    # When `true`, indicates that the client is to be late cancelled from the
+    # class.<br />
+    # When `false`, indicates that the client is to be early cancelled from the
+    # class.<br />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :late_cancel
+
+    # The ID of the client visit that you want to remove from the class.
+    # Default: **0**
+    # @return [Integer]
+    attr_accessor :visit_id
+
+    # 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['class_id'] = 'ClassId'
+      @_hash['test'] = 'Test'
+      @_hash['send_email'] = 'SendEmail'
+      @_hash['late_cancel'] = 'LateCancel'
+      @_hash['visit_id'] = 'VisitId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        unique_client_id
+        test
+        send_email
+        late_cancel
+        visit_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(class_id = nil, client_id = SKIP, unique_client_id = SKIP,
+                   test = SKIP, send_email = SKIP, late_cancel = SKIP,
+                   visit_id = SKIP)
+      @client_id = client_id unless client_id == SKIP
+      @unique_client_id = unique_client_id unless unique_client_id == SKIP
+      @class_id = class_id
+      @test = test unless test == SKIP
+      @send_email = send_email unless send_email == SKIP
+      @late_cancel = late_cancel unless late_cancel == SKIP
+      @visit_id = visit_id unless visit_id == 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.
+      class_id = hash.key?('ClassId') ? hash['ClassId'] : nil
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : SKIP
+      unique_client_id =
+        hash.key?('UniqueClientId') ? hash['UniqueClientId'] : SKIP
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+      send_email = hash.key?('SendEmail') ? hash['SendEmail'] : SKIP
+      late_cancel = hash.key?('LateCancel') ? hash['LateCancel'] : SKIP
+      visit_id = hash.key?('VisitId') ? hash['VisitId'] : SKIP
+
+      # Create object from extracted values.
+      RemoveClientFromClassRequest.new(class_id,
+                                       client_id,
+                                       unique_client_id,
+                                       test,
+                                       send_email,
+                                       late_cancel,
+                                       visit_id)
+    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}, class_id:"\
+      " #{@class_id}, test: #{@test}, send_email: #{@send_email}, late_cancel: #{@late_cancel},"\
+      " visit_id: #{@visit_id}>"
+    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}, class_id: #{@class_id.inspect}, test: #{@test.inspect},"\
+      " send_email: #{@send_email.inspect}, late_cancel: #{@late_cancel.inspect}, visit_id:"\
+      " #{@visit_id.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/remove_client_from_class_response.rb

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