/* Options:
Date: 2024-11-24 13:20:22
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://clubready.com/api/current
//GlobalNamespace:
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion:
//InitializeCollections: True
//ExportValueTypes: False
IncludeTypes: CreateProspectRequest.*
//ExcludeTypes:
//AddNamespaces:
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api.Members.Model;
namespace ClubReady.Core.Api.Models
{
public partial class ApiDtoBase
{
public virtual string ApiKey { get; set; }
public virtual int? StoreId { get; set; }
public virtual int? ChainId { get; set; }
}
public partial class CreateProspectRequestDto
: ApiDtoBase
{
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string Address { get; set; }
public virtual string City { get; set; }
public virtual string State { get; set; }
public virtual string Zip { get; set; }
public virtual string Email { get; set; }
public virtual string Gender { get; set; }
public virtual int? AddPackageId { get; set; }
public virtual int? ProspectTypeId { get; set; }
public virtual int? ReferralTypeId { get; set; }
public virtual bool SendEmail { get; set; }
public virtual string Phone { get; set; }
public virtual string WorkPhone { get; set; }
public virtual DateTime? DateOfBirth { get; set; }
public virtual string CellPhone { get; set; }
public virtual string Coupon { get; set; }
public virtual string Note { get; set; }
public virtual int? EmailTemplateId { get; set; }
public virtual string ExternalId { get; set; }
public virtual int? ReferredBy { get; set; }
public virtual int? AssignToId { get; set; }
public virtual int AssignToMethod { get; set; }
public virtual int? ContactedHow { get; set; }
public virtual string Username { get; set; }
public virtual string EmergencyContactName { get; set; }
public virtual string EmergencyContactPhone { get; set; }
public virtual string EmergencyContactType { get; set; }
public virtual bool EmailOptOut { get; set; }
public virtual bool? NonPromotionalSmsOptedIn { get; set; }
public virtual bool? PromotionalSmsOptedIn { get; set; }
}
}
namespace ClubReady.Web.Api
{
public partial interface IApiKeyEndpoint
{
string ApiKey { get; set; }
}
public partial interface IRestrictedApiRequest
: IApiKeyEndpoint
{
int? RestrictedId { get; set; }
RestrictedResourceType RestrictedResourceType { get; set; }
}
public enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
}
namespace ClubReady.Web.Api.Members.Model
{
[Route("/users/prospect", "POST")]
public partial class CreateProspectRequest
: CreateProspectRequestDto, IRestrictedApiRequest
{
///
///Api Key - grants access to resources
///
[ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
public virtual string ApiKey { get; set; }
///
///ClubReady Club ID (StoreID internally)
///
[ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")]
public virtual int? StoreId { get; set; }
///
///First Name
///
[ApiMember(DataType="string", Description="First Name", IsRequired=true, Name="FirstName", ParameterType="query")]
public virtual string FirstName { get; set; }
///
///Last Name
///
[ApiMember(DataType="string", Description="Last Name", IsRequired=true, Name="LastName", ParameterType="query")]
public virtual string LastName { get; set; }
///
///Email Address
///
[ApiMember(DataType="string", Description="Email Address", IsRequired=true, Name="Email", ParameterType="query")]
public virtual string Email { get; set; }
///
///Gender (Format:'M'|'F')
///
[ApiMember(DataType="string", Description="Gender (Format:'M'|'F')", Name="Gender", ParameterType="query")]
public virtual string Gender { get; set; }
///
///Address
///
[ApiMember(DataType="string", Description="Address", Name="Address", ParameterType="query")]
public virtual string Address { get; set; }
///
///City
///
[ApiMember(DataType="string", Description="City", Name="City", ParameterType="query")]
public virtual string City { get; set; }
[ApiMember(DataType="string", Name="State", ParameterType="query")]
public virtual string State { get; set; }
[ApiMember(DataType="string", Name="Zip", ParameterType="query")]
public virtual string Zip { get; set; }
///
///Home phone
///
[ApiMember(DataType="string", Description="Home phone", Name="Phone", ParameterType="query")]
public virtual string Phone { get; set; }
///
///Work phone
///
[ApiMember(DataType="string", Description="Work phone", Name="WorkPhone", ParameterType="query")]
public virtual string WorkPhone { get; set; }
///
///Date of Birth (Format:YYYY-MM-DD)
///
[ApiMember(DataType="date", Description="Date of Birth (Format:YYYY-MM-DD)", Name="DateOfBirth", ParameterType="query")]
public virtual DateTime? DateOfBirth { get; set; }
///
///Cell phone
///
[ApiMember(DataType="string", Description="Cell phone", Name="CellPhone", ParameterType="query")]
public virtual string CellPhone { get; set; }
///
///Specify a Package to apply to the new prospect
///
[ApiMember(DataType="integer", Description="Specify a Package to apply to the new prospect", Name="AddPackageId", ParameterType="query")]
public virtual int? AddPackageId { get; set; }
///
///Specify a specific Prospect Type for the new prospect
///
[ApiMember(DataType="integer", Description="Specify a specific Prospect Type for the new prospect", Name="ProspectTypeId", ParameterType="query")]
public virtual int? ProspectTypeId { get; set; }
///
///Specify a specific Referral Type for the new prospect
///
[ApiMember(DataType="integer", Description="Specify a specific Referral Type for the new prospect", Name="ReferralTypeId", ParameterType="query")]
public virtual int? ReferralTypeId { get; set; }
///
///Send a Welcome email to the new prospect (Format:true|false)
///
[ApiMember(DataType="boolean", Description="Send a Welcome email to the new prospect (Format:true|false)", IsRequired=true, Name="SendEmail", ParameterType="query")]
public virtual bool SendEmail { get; set; }
///
///Only used if SendEmail = True
///
[ApiMember(DataType="integer", Description="Only used if SendEmail = True", Name="EmailTemplateId", ParameterType="query")]
public virtual int? EmailTemplateId { get; set; }
///
///
///
[ApiMember(DataType="string", Description="", Name="Coupon", ParameterType="query")]
public virtual string Coupon { get; set; }
///
///Add an internal note for the new prospect
///
[ApiMember(DataType="string", Description="Add an internal note for the new prospect", Name="Note", ParameterType="query")]
public virtual string Note { get; set; }
///
///Unique ID for the user from your system. We store internally as ExternalUserId
///
[ApiMember(DataType="string", Description="Unique ID for the user from your system. We store internally as ExternalUserId", Name="ExternalId", ParameterType="query")]
public virtual string ExternalId { get; set; }
///
///User ID of existing user who referred them.
///
[ApiMember(DataType="integer", Description="User ID of existing user who referred them.", Name="ReferredBy", ParameterType="query")]
public virtual int? ReferredBy { get; set; }
///
///ClubReady UserId of staff to assign new member to.
///
[ApiMember(DataType="integer", Description="ClubReady UserId of staff to assign new member to.", Name="AssignToId", ParameterType="query")]
public virtual int? AssignToId { get; set; }
///
///Who should be assigned to this lead? 0 = Default lead assignments, 1 = When passing in a ReferredBy user, assign the new Lead to that referring user's Staff assignment.
///
[ApiMember(DataType="integer", Description="Who should be assigned to this lead? 0 = Default lead assignments, 1 = When passing in a ReferredBy user, assign the new Lead to that referring user's Staff assignment.", Name="AssignToMethod", ParameterType="query")]
public virtual int AssignToMethod { get; set; }
///
///Username needs to be between 4 and 255 characters
///
[ApiMember(DataType="string", Description="Username needs to be between 4 and 255 characters", Name="Username", ParameterType="query")]
public virtual string Username { get; set; }
///
///Emergency contact name
///
[ApiMember(DataType="string", Description="Emergency contact name", Name="EmergencyContactName", ParameterType="query")]
public virtual string EmergencyContactName { get; set; }
///
///Emergency contact phone number
///
[ApiMember(DataType="string", Description="Emergency contact phone number", Name="EmergencyContactPhone", ParameterType="query")]
public virtual string EmergencyContactPhone { get; set; }
///
///Emergency contact relationship
///
[ApiMember(DataType="string", Description="Emergency contact relationship", Name="EmergencyContactType", ParameterType="query")]
public virtual string EmergencyContactType { get; set; }
///
///Set a prospect's email opt out status (Format:true|false)
///
[ApiMember(DataType="boolean", Description="Set a prospect's email opt out status (Format:true|false)", Name="EmailOptOut", ParameterType="query")]
public virtual bool EmailOptOut { get; set; }
///
///Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)
///
[ApiMember(DataType="boolean", Description="Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)", Name="NonPromotionalSmsOptedIn", ParameterType="query")]
public virtual bool? NonPromotionalSmsOptedIn { get; set; }
///
///Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)
///
[ApiMember(DataType="boolean", Description="Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)", Name="PromotionalSmsOptedIn", ParameterType="query")]
public virtual bool? PromotionalSmsOptedIn { get; set; }
public virtual int? RestrictedId { get; set; }
public virtual RestrictedResourceType RestrictedResourceType { get; set; }
}
}