mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/models/get_active_client_memberships_request.rb

@@ -0,0 +1,163 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetActiveClientMembershipsRequest Model.
+  class GetActiveClientMembershipsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client for whom memberships are returned.
+    # @return [String]
+    attr_accessor :client_id
+
+    # The Unique ID of the client for whom memberships are returned. Note that
+    # UniqueClientId takes precedence over ClientId if both are provided.
+    # @return [Integer]
+    attr_accessor :unique_client_id
+
+    # Filters results to memberships that can be used to pay for scheduled
+    # services at that location. This parameter can not be passed when
+    # `CrossRegionalLookup` is `true`.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Used to retrieve a client’s memberships from multiple sites within an
+    # organization. When included and set to `true`, it searches a maximum of
+    # ten sites with which this client is associated. When a client is
+    # associated with more than ten sites, use `ClientAssociatedSitesOffset` as
+    # many times as needed to search the additional sites with which the client
+    # is associated. You can use the `CrossRegionalClientAssociations` value
+    # from `GET CrossRegionalClientAssociations` to determine how many sites the
+    # client is associated with. Note that a `SiteID` is returned and populated
+    # in the `ClientServices` response when `CrossRegionalLookup` is set to
+    # `true`.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cross_regional_lookup
+
+    # Used to retrieve a client’s memberships from multiple sites within an
+    # organization when the client is associated with more than ten sites. To
+    # change which ten sites are searched, change this offset value. A value of
+    # 0 means that no sites are skipped and the first ten sites are returned.
+    # You can use the `CrossRegionalClientAssociations` value from `GET
+    # CrossRegionalClientAssociations` to determine how many sites the client is
+    # associated with. Note that you must always have `CrossRegionalLookup` set
+    # to `true` to use this parameter.<br />
+    # Default: **0**
+    # For example, if a client is associated with 25 sites, you need to call GET
+    # `ActiveClientMemberships` three times, as follows:
+    # * Use GET `CrossRegionalClientAssociations` to determine how many sites a
+    # client is associated with, which tells you how many additional calls you
+    # need to make.
+    # * Either omit `ClientAssociatedSitesOffset` or set it to 0 to return the
+    # client’s memberships from sites 1-10
+    # * Set `ClientAssociatedSitesOffset` to 10 to return the client’s
+    # memberships from sites 11-20
+    # * Set `ClientAssociatedSitesOffset` to 20 to return the client’s
+    # memberships from sites 21-25
+    # @return [Integer]
+    attr_accessor :client_associated_sites_offset
+
+    # 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['location_id'] = 'LocationId'
+      @_hash['cross_regional_lookup'] = 'CrossRegionalLookup'
+      @_hash['client_associated_sites_offset'] = 'ClientAssociatedSitesOffset'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unique_client_id
+        location_id
+        cross_regional_lookup
+        client_associated_sites_offset
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id = nil, unique_client_id = SKIP, location_id = SKIP,
+                   cross_regional_lookup = SKIP,
+                   client_associated_sites_offset = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @client_id = client_id
+      @unique_client_id = unique_client_id unless unique_client_id == SKIP
+      @location_id = location_id unless location_id == SKIP
+      @cross_regional_lookup = cross_regional_lookup unless cross_regional_lookup == SKIP
+      unless client_associated_sites_offset == SKIP
+        @client_associated_sites_offset =
+          client_associated_sites_offset
+      end
+      @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
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      cross_regional_lookup =
+        hash.key?('CrossRegionalLookup') ? hash['CrossRegionalLookup'] : SKIP
+      client_associated_sites_offset =
+        hash.key?('ClientAssociatedSitesOffset') ? hash['ClientAssociatedSitesOffset'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetActiveClientMembershipsRequest.new(client_id,
+                                            unique_client_id,
+                                            location_id,
+                                            cross_regional_lookup,
+                                            client_associated_sites_offset,
+                                            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}, unique_client_id: #{@unique_client_id},"\
+      " location_id: #{@location_id}, cross_regional_lookup: #{@cross_regional_lookup},"\
+      " client_associated_sites_offset: #{@client_associated_sites_offset}, 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}, location_id: #{@location_id.inspect}, cross_regional_lookup:"\
+      " #{@cross_regional_lookup.inspect}, client_associated_sites_offset:"\
+      " #{@client_associated_sites_offset.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_active_client_memberships_response.rb

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

data/lib/mindbody_public_api/models/get_active_clients_memberships_request.rb

@@ -0,0 +1,151 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # GetActiveClientsMembershipsRequest Model.
+  class GetActiveClientsMembershipsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the client for whom memberships are returned. Maximum allowed :
+    # 200.
+    # @return [Array[String]]
+    attr_accessor :client_ids
+
+    # Filters results to memberships that can be used to pay for scheduled
+    # services at that location. This parameter can not be passed when
+    # `CrossRegionalLookup` is `true`.
+    # @return [Integer]
+    attr_accessor :location_id
+
+    # Used to retrieve a client’s memberships from multiple sites within an
+    # organization. When included and set to `true`, it searches a maximum of
+    # ten sites with which this client is associated. When a client is
+    # associated with more than ten sites, use `ClientAssociatedSitesOffset` as
+    # many times as needed to search the additional sites with which the client
+    # is associated. You can use the `CrossRegionalClientAssociations` value
+    # from `GET CrossRegionalClientAssociations` to determine how many sites the
+    # client is associated with. Note that a `SiteID` is returned and populated
+    # in the `ClientServices` response when `CrossRegionalLookup` is set to
+    # `true`.
+    # Default: **false**
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cross_regional_lookup
+
+    # Used to retrieve a client’s memberships from multiple sites within an
+    # organization when the client is associated with more than ten sites. To
+    # change which ten sites are searched, change this offset value. A value of
+    # 0 means that no sites are skipped and the first ten sites are returned.
+    # You can use the `CrossRegionalClientAssociations` value from `GET
+    # CrossRegionalClientAssociations` to determine how many sites the client is
+    # associated with. Note that you must always have `CrossRegionalLookup` set
+    # to `true` to use this parameter.<br />
+    # Default: **0**
+    # For example, if a client is associated with 25 sites, you need to call
+    # `GetClientServices` three times, as follows:
+    # * Use `GET CrossRegionalClientAssociations` to determine how many sites a
+    # client is associated with, which tells you how many additional calls you
+    # need to make.
+    # * Either omit `ClientAssociatedSitesOffset` or set it to 0 to return the
+    # client’s services (pricing options) from sites 1-10.
+    # * Set `ClientAssociatedSitesOffset` to 10 to return the client pricing
+    # options from sites 11-20
+    # * Set `ClientAssociatedSitesOffset` to 20 to return the client pricing
+    # options from sites 21-25
+    # @return [Integer]
+    attr_accessor :client_associated_sites_offset
+
+    # 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_ids'] = 'ClientIds'
+      @_hash['location_id'] = 'LocationId'
+      @_hash['cross_regional_lookup'] = 'CrossRegionalLookup'
+      @_hash['client_associated_sites_offset'] = 'ClientAssociatedSitesOffset'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        location_id
+        cross_regional_lookup
+        client_associated_sites_offset
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_ids = nil, location_id = SKIP,
+                   cross_regional_lookup = SKIP,
+                   client_associated_sites_offset = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @client_ids = client_ids
+      @location_id = location_id unless location_id == SKIP
+      @cross_regional_lookup = cross_regional_lookup unless cross_regional_lookup == SKIP
+      unless client_associated_sites_offset == SKIP
+        @client_associated_sites_offset =
+          client_associated_sites_offset
+      end
+      @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_ids = hash.key?('ClientIds') ? hash['ClientIds'] : nil
+      location_id = hash.key?('LocationId') ? hash['LocationId'] : SKIP
+      cross_regional_lookup =
+        hash.key?('CrossRegionalLookup') ? hash['CrossRegionalLookup'] : SKIP
+      client_associated_sites_offset =
+        hash.key?('ClientAssociatedSitesOffset') ? hash['ClientAssociatedSitesOffset'] : SKIP
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetActiveClientsMembershipsRequest.new(client_ids,
+                                             location_id,
+                                             cross_regional_lookup,
+                                             client_associated_sites_offset,
+                                             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_ids: #{@client_ids}, location_id: #{@location_id},"\
+      " cross_regional_lookup: #{@cross_regional_lookup}, client_associated_sites_offset:"\
+      " #{@client_associated_sites_offset}, 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_ids: #{@client_ids.inspect}, location_id: #{@location_id.inspect},"\
+      " cross_regional_lookup: #{@cross_regional_lookup.inspect}, client_associated_sites_offset:"\
+      " #{@client_associated_sites_offset.inspect}, limit: #{@limit.inspect}, offset:"\
+      " #{@offset.inspect}>"
+    end
+  end
+end

data/lib/mindbody_public_api/models/get_active_clients_memberships_response.rb

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

data/lib/mindbody_public_api/models/get_active_session_times_request.rb

@@ -0,0 +1,136 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module MindbodyPublicApi
+  # GetActiveSessionTimesRequest Model.
+  class GetActiveSessionTimesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Filters on the provided the schedule type. Either `SessionTypeIds` or
+    # `ScheduleType` must be provided.
+    # @return [ScheduleType1Enum]
+    attr_accessor :schedule_type
+
+    # Filters on the provided session type IDs. Either `SessionTypeIds` or
+    # `ScheduleType` must be provided.
+    # @return [Array[Integer]]
+    attr_accessor :session_type_ids
+
+    # Filters results to times that start on or after this time on the current
+    # date. Any date provided is ignored.
+    # <br />Default: **00:00:00**
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # Filters results to times that end on or before this time on the current
+    # date. Any date provided is ignored..
+    # <br />Default: **23:59:59**
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # 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['schedule_type'] = 'ScheduleType'
+      @_hash['session_type_ids'] = 'SessionTypeIds'
+      @_hash['start_time'] = 'StartTime'
+      @_hash['end_time'] = 'EndTime'
+      @_hash['limit'] = 'Limit'
+      @_hash['offset'] = 'Offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        schedule_type
+        session_type_ids
+        start_time
+        end_time
+        limit
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(schedule_type = SKIP, session_type_ids = SKIP,
+                   start_time = SKIP, end_time = SKIP, limit = SKIP,
+                   offset = SKIP)
+      @schedule_type = schedule_type unless schedule_type == SKIP
+      @session_type_ids = session_type_ids unless session_type_ids == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == 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.
+      schedule_type = hash.key?('ScheduleType') ? hash['ScheduleType'] : SKIP
+      session_type_ids =
+        hash.key?('SessionTypeIds') ? hash['SessionTypeIds'] : SKIP
+      start_time = if hash.key?('StartTime')
+                     (DateTimeHelper.from_rfc3339(hash['StartTime']) if hash['StartTime'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('EndTime')
+                   (DateTimeHelper.from_rfc3339(hash['EndTime']) if hash['EndTime'])
+                 else
+                   SKIP
+                 end
+      limit = hash.key?('Limit') ? hash['Limit'] : SKIP
+      offset = hash.key?('Offset') ? hash['Offset'] : SKIP
+
+      # Create object from extracted values.
+      GetActiveSessionTimesRequest.new(schedule_type,
+                                       session_type_ids,
+                                       start_time,
+                                       end_time,
+                                       limit,
+                                       offset)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_custom_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} schedule_type: #{@schedule_type}, session_type_ids: #{@session_type_ids},"\
+      " start_time: #{@start_time}, end_time: #{@end_time}, 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} schedule_type: #{@schedule_type.inspect}, session_type_ids:"\
+      " #{@session_type_ids.inspect}, start_time: #{@start_time.inspect}, end_time:"\
+      " #{@end_time.inspect}, limit: #{@limit.inspect}, offset: #{@offset.inspect}>"
+    end
+  end
+end