ClubReady Api

AgreementAddEndpoint

The following routes are available for this service:
POST	/sales/agreement/add	Set up a package that will be sold to an existing user	Set up a package that will be sold to an existing user. The PaymentMethods property is an array of objects describing how you want ClubReady to take payment while selling the PackageId/InstallmentPlanId. If omitted (or null), the preferred on-file profile will be used. The header `X-Forwarded-For` is required and should be set to the IP address of the end user.


export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

// @ApiResponse(Description="", ResponseType="typeof(ClubReady.Web.Api.Sales.Agreement.AddResponse)", StatusCode=200)
export class AgreementAddEndpoint implements IAddEndpoint, IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * Api Authentication Key
    */
    // @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    public ApiKey: string;

    /**
    * Member Id of the user buying the Package
    */
    // @ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
    public MemberId: number;

    public ChainId?: number;
    /**
    * Id of the store for the user
    */
    // @ApiMember(Description="Id of the store for the user", IsRequired=true)
    public StoreId: number;

    /**
    * Package Id number of the package being purchased
    */
    // @ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
    public PackageId: number;

    /**
    * Installment Plan Id being purchased. If empty, the default package will be selected.
    */
    // @ApiMember(Description="Installment Plan Id being purchased. If empty, the default package will be selected.")
    public InstallmentId?: number;

    /**
    * Date contract takes affect
    */
    // @ApiMember(Description="Date contract takes affect")
    public StartDate?: string;

    /**
    * Promo code to apply a discount.
    */
    // @ApiMember(Description="Promo code to apply a discount.")
    public PromoCode?: string;

    /**
    * Staff Id of salesperson who sold the agreement.
    */
    // @ApiMember(Description="Staff Id of salesperson who sold the agreement.")
    public StaffId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<AgreementAddEndpoint>) { (Object as any).assign(this, init); }
}

export class ApiResponse2Base
{
    public success: boolean;
    public message?: string;

    public constructor(init?: Partial<ApiResponse2Base>) { (Object as any).assign(this, init); }
}

export class AddResponse extends ApiResponse2Base
{
    public incompleteAgreementToken?: string;
    public contractId?: number;

    public constructor(init?: Partial<AddResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AgreementAddEndpoint DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sales/agreement/add HTTP/1.1 
Host: www.clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"XForwardedFor":"String","ApiKey":"String","MemberId":0,"ChainId":0,"StoreId":0,"PackageId":0,"InstallmentId":0,"StartDate":"0001-01-01T00:00:00.0000000","PromoCode":"String","StaffId":0,"RestrictedId":0,"RestrictedResourceType":"Store"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"incompleteAgreementToken":"String","contractId":0,"success":false,"message":"String"}