mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/color.rb

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

data/lib/mindbody_public_api/models/commission_detail.rb

@@ -0,0 +1,83 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # CommissionDetail Model.
+  class CommissionDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of commission earned. Possible values are:
+    # * ItemStandardPercentageCommission
+    # * ItemStandardFlatCommission
+    # * ItemPromotionalPercentageCommission
+    # * ItemPromotionalFlatCommission
+    # * StaffStandardPercentageCommission
+    # * StaffStandardFlatCommission
+    # * StaffPromotionalPercentageCommission
+    # * StaffPromotionalFlatCommission
+    # @return [String]
+    attr_accessor :commission_type
+
+    # The portion of `Earnings` earned by this `CommissionType`.
+    # @return [Float]
+    attr_accessor :commission_earnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['commission_type'] = 'CommissionType'
+      @_hash['commission_earnings'] = 'CommissionEarnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        commission_type
+        commission_earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(commission_type = SKIP, commission_earnings = SKIP)
+      @commission_type = commission_type unless commission_type == SKIP
+      @commission_earnings = commission_earnings unless commission_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.
+      commission_type =
+        hash.key?('CommissionType') ? hash['CommissionType'] : SKIP
+      commission_earnings =
+        hash.key?('CommissionEarnings') ? hash['CommissionEarnings'] : SKIP
+
+      # Create object from extracted values.
+      CommissionDetail.new(commission_type,
+                           commission_earnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commission_type: #{@commission_type}, commission_earnings:"\
+      " #{@commission_earnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} commission_type: #{@commission_type.inspect}, commission_earnings:"\
+      " #{@commission_earnings.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/commission_payroll_purchase_event.rb

@@ -0,0 +1,143 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # CommissionPayrollPurchaseEvent Model.
+  class CommissionPayrollPurchaseEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the staff member who earned commissions.
+    # @return [Integer]
+    attr_accessor :staff_id
+
+    # The date and time when the sale occurred.
+    # @return [DateTime]
+    attr_accessor :sale_date_time
+
+    # The sale’s ID.
+    # @return [Integer]
+    attr_accessor :sale_id
+
+    # The Sales type. When this is "Purchase" indicates that this sale paid
+    # commission to a staff. When this is "Return"
+    # @return [String]
+    attr_accessor :sale_type
+
+    # The product ID of the item for which the staff earned commissions.
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # Contains information about which commissions the staff earned for this
+    # item.
+    # @return [Array[CommissionDetail]]
+    attr_accessor :earnings_details
+
+    # The total commissions earned by the staff for this item.
+    # @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_date_time'] = 'SaleDateTime'
+      @_hash['sale_id'] = 'SaleId'
+      @_hash['sale_type'] = 'SaleType'
+      @_hash['product_id'] = 'ProductId'
+      @_hash['earnings_details'] = 'EarningsDetails'
+      @_hash['earnings'] = 'Earnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        staff_id
+        sale_date_time
+        sale_id
+        sale_type
+        product_id
+        earnings_details
+        earnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(staff_id = SKIP, sale_date_time = SKIP, sale_id = SKIP,
+                   sale_type = SKIP, product_id = SKIP, earnings_details = SKIP,
+                   earnings = SKIP)
+      @staff_id = staff_id unless staff_id == SKIP
+      @sale_date_time = sale_date_time unless sale_date_time == SKIP
+      @sale_id = sale_id unless sale_id == SKIP
+      @sale_type = sale_type unless sale_type == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @earnings_details = earnings_details unless earnings_details == 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_date_time = if hash.key?('SaleDateTime')
+                         (DateTimeHelper.from_rfc3339(hash['SaleDateTime']) if hash['SaleDateTime'])
+                       else
+                         SKIP
+                       end
+      sale_id = hash.key?('SaleId') ? hash['SaleId'] : SKIP
+      sale_type = hash.key?('SaleType') ? hash['SaleType'] : SKIP
+      product_id = hash.key?('ProductId') ? hash['ProductId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      earnings_details = nil
+      unless hash['EarningsDetails'].nil?
+        earnings_details = []
+        hash['EarningsDetails'].each do |structure|
+          earnings_details << (CommissionDetail.from_hash(structure) if structure)
+        end
+      end
+
+      earnings_details = SKIP unless hash.key?('EarningsDetails')
+      earnings = hash.key?('Earnings') ? hash['Earnings'] : SKIP
+
+      # Create object from extracted values.
+      CommissionPayrollPurchaseEvent.new(staff_id,
+                                         sale_date_time,
+                                         sale_id,
+                                         sale_type,
+                                         product_id,
+                                         earnings_details,
+                                         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_date_time: #{@sale_date_time}, sale_id:"\
+      " #{@sale_id}, sale_type: #{@sale_type}, product_id: #{@product_id}, earnings_details:"\
+      " #{@earnings_details}, 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_date_time: #{@sale_date_time.inspect},"\
+      " sale_id: #{@sale_id.inspect}, sale_type: #{@sale_type.inspect}, product_id:"\
+      " #{@product_id.inspect}, earnings_details: #{@earnings_details.inspect}, earnings:"\
+      " #{@earnings.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/complete_checkout_shopping_cart_using_alternative_payments_request.rb

@@ -0,0 +1,86 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # The API Request model for Complete Checkout Shopping Cart API.
+  class CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Access Token generated during Pre-Payment step.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The RSSID of the client making the purchase. A cart can be validated
+    # without a client ID, but a client ID must be specified to complete a sale.
+    # @return [String]
+    attr_accessor :client_id
+
+    # When `true`, indicates that the contents of the cart are validated, but
+    # the transaction does not take place. You should use this parameter during
+    # testing and when checking the calculated totals of the items in the
+    # cart.<br />
+    # When `false`, the transaction takes place and the database is affected.<br
+    # />
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'AccessToken'
+      @_hash['client_id'] = 'ClientId'
+      @_hash['test'] = 'Test'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        test
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token = nil, client_id = nil, test = SKIP)
+      @access_token = access_token
+      @client_id = client_id
+      @test = test unless test == 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.
+      access_token = hash.key?('AccessToken') ? hash['AccessToken'] : nil
+      client_id = hash.key?('ClientId') ? hash['ClientId'] : nil
+      test = hash.key?('Test') ? hash['Test'] : SKIP
+
+      # Create object from extracted values.
+      CompleteCheckoutShoppingCartUsingAlternativePaymentsRequest.new(access_token,
+                                                                      client_id,
+                                                                      test)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token}, client_id: #{@client_id}, test: #{@test}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} access_token: #{@access_token.inspect}, client_id: #{@client_id.inspect},"\
+      " test: #{@test.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/contact_log.rb

@@ -0,0 +1,198 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # A contact log.
+  class ContactLog < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The contact log’s ID.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The contact log’s body text.
+    # @return [String]
+    attr_accessor :text
+
+    # The local date and time when the contact log was created.
+    # @return [DateTime]
+    attr_accessor :created_date_time
+
+    # The date by which the assigned staff member should close or follow up on
+    # this contact log.
+    # @return [DateTime]
+    attr_accessor :followup_by_date
+
+    # The method by which the client wants to be contacted.
+    # @return [String]
+    attr_accessor :contact_method
+
+    # The name of the client to contact.
+    # @return [String]
+    attr_accessor :contact_name
+
+    # The Client.
+    # @return [Client]
+    attr_accessor :client
+
+    # The Staff
+    # @return [Staff]
+    attr_accessor :created_by
+
+    # The Staff
+    # @return [Staff]
+    attr_accessor :assigned_to
+
+    # Information about the comment.
+    # @return [Array[ContactLogComment]]
+    attr_accessor :comments
+
+    # Information about the type of contact log.
+    # @return [Array[ContactLogType]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['text'] = 'Text'
+      @_hash['created_date_time'] = 'CreatedDateTime'
+      @_hash['followup_by_date'] = 'FollowupByDate'
+      @_hash['contact_method'] = 'ContactMethod'
+      @_hash['contact_name'] = 'ContactName'
+      @_hash['client'] = 'Client'
+      @_hash['created_by'] = 'CreatedBy'
+      @_hash['assigned_to'] = 'AssignedTo'
+      @_hash['comments'] = 'Comments'
+      @_hash['types'] = 'Types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        text
+        created_date_time
+        followup_by_date
+        contact_method
+        contact_name
+        client
+        created_by
+        assigned_to
+        comments
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, text = SKIP, created_date_time = SKIP,
+                   followup_by_date = SKIP, contact_method = SKIP,
+                   contact_name = SKIP, client = SKIP, created_by = SKIP,
+                   assigned_to = SKIP, comments = SKIP, types = SKIP)
+      @id = id unless id == SKIP
+      @text = text unless text == SKIP
+      @created_date_time = created_date_time unless created_date_time == SKIP
+      @followup_by_date = followup_by_date unless followup_by_date == SKIP
+      @contact_method = contact_method unless contact_method == SKIP
+      @contact_name = contact_name unless contact_name == SKIP
+      @client = client unless client == SKIP
+      @created_by = created_by unless created_by == SKIP
+      @assigned_to = assigned_to unless assigned_to == SKIP
+      @comments = comments unless comments == SKIP
+      @types = types unless types == 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
+      text = hash.key?('Text') ? hash['Text'] : SKIP
+      created_date_time = if hash.key?('CreatedDateTime')
+                            (DateTimeHelper.from_rfc3339(hash['CreatedDateTime']) if hash['CreatedDateTime'])
+                          else
+                            SKIP
+                          end
+      followup_by_date = if hash.key?('FollowupByDate')
+                           (DateTimeHelper.from_rfc3339(hash['FollowupByDate']) if hash['FollowupByDate'])
+                         else
+                           SKIP
+                         end
+      contact_method = hash.key?('ContactMethod') ? hash['ContactMethod'] : SKIP
+      contact_name = hash.key?('ContactName') ? hash['ContactName'] : SKIP
+      client = Client.from_hash(hash['Client']) if hash['Client']
+      created_by = Staff.from_hash(hash['CreatedBy']) if hash['CreatedBy']
+      assigned_to = Staff.from_hash(hash['AssignedTo']) if hash['AssignedTo']
+      # Parameter is an array, so we need to iterate through it
+      comments = nil
+      unless hash['Comments'].nil?
+        comments = []
+        hash['Comments'].each do |structure|
+          comments << (ContactLogComment.from_hash(structure) if structure)
+        end
+      end
+
+      comments = SKIP unless hash.key?('Comments')
+      # Parameter is an array, so we need to iterate through it
+      types = nil
+      unless hash['Types'].nil?
+        types = []
+        hash['Types'].each do |structure|
+          types << (ContactLogType.from_hash(structure) if structure)
+        end
+      end
+
+      types = SKIP unless hash.key?('Types')
+
+      # Create object from extracted values.
+      ContactLog.new(id,
+                     text,
+                     created_date_time,
+                     followup_by_date,
+                     contact_method,
+                     contact_name,
+                     client,
+                     created_by,
+                     assigned_to,
+                     comments,
+                     types)
+    end
+
+    def to_custom_created_date_time
+      DateTimeHelper.to_rfc3339(created_date_time)
+    end
+
+    def to_custom_followup_by_date
+      DateTimeHelper.to_rfc3339(followup_by_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, text: #{@text}, created_date_time: #{@created_date_time},"\
+      " followup_by_date: #{@followup_by_date}, contact_method: #{@contact_method}, contact_name:"\
+      " #{@contact_name}, client: #{@client}, created_by: #{@created_by}, assigned_to:"\
+      " #{@assigned_to}, comments: #{@comments}, types: #{@types}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, text: #{@text.inspect}, created_date_time:"\
+      " #{@created_date_time.inspect}, followup_by_date: #{@followup_by_date.inspect},"\
+      " contact_method: #{@contact_method.inspect}, contact_name: #{@contact_name.inspect},"\
+      " client: #{@client.inspect}, created_by: #{@created_by.inspect}, assigned_to:"\
+      " #{@assigned_to.inspect}, comments: #{@comments.inspect}, types: #{@types.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/contact_log_comment.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
+  # A contact log comment.
+  class ContactLogComment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The comment’s ID.
+    # @return [Integer]
+    attr_accessor :id
+
+    # The comment’s body text.
+    # @return [String]
+    attr_accessor :text
+
+    # The local time when the comment was created.
+    # @return [DateTime]
+    attr_accessor :created_date_time
+
+    # The Staff
+    # @return [Staff]
+    attr_accessor :created_by
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'Id'
+      @_hash['text'] = 'Text'
+      @_hash['created_date_time'] = 'CreatedDateTime'
+      @_hash['created_by'] = 'CreatedBy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        text
+        created_date_time
+        created_by
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, text = SKIP, created_date_time = SKIP,
+                   created_by = SKIP)
+      @id = id unless id == SKIP
+      @text = text unless text == SKIP
+      @created_date_time = created_date_time unless created_date_time == SKIP
+      @created_by = created_by unless created_by == 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
+      text = hash.key?('Text') ? hash['Text'] : SKIP
+      created_date_time = if hash.key?('CreatedDateTime')
+                            (DateTimeHelper.from_rfc3339(hash['CreatedDateTime']) if hash['CreatedDateTime'])
+                          else
+                            SKIP
+                          end
+      created_by = Staff.from_hash(hash['CreatedBy']) if hash['CreatedBy']
+
+      # Create object from extracted values.
+      ContactLogComment.new(id,
+                            text,
+                            created_date_time,
+                            created_by)
+    end
+
+    def to_custom_created_date_time
+      DateTimeHelper.to_rfc3339(created_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, text: #{@text}, created_date_time: #{@created_date_time},"\
+      " created_by: #{@created_by}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, text: #{@text.inspect}, created_date_time:"\
+      " #{@created_date_time.inspect}, created_by: #{@created_by.inspect}>"
+    end
+  end
+end