ClubReady Api

GetSalesPackageDiscountsRequest

The following routes are available for this service:
GET	/sales/packages/{PackageId}/installments	Get sales package installments

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiDtoBase:
    api_key: Optional[str] = None
    store_id: Optional[int] = None
    chain_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSalesPackageInstallmentsDto(ApiDtoBase):
    package_id: int = 0


class RestrictedResourceType(str, Enum):
    STORE = 'Store'
    CHAIN = 'Chain'
    USER = 'User'
    UNDEFINED = 'Undefined'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSalesPackageDiscountsRequest(GetSalesPackageInstallmentsDto, IRestrictedApiRequest):
    # @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    api_key: Optional[str] = None
    """
    Api Key - grants access to resources
    """


    # @ApiMember(DataType="string", Description="ID # of store to get package plans for", IsRequired=true, Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    ID # of store to get package plans for
    """


    # @ApiMember(DataType="string", Description="ID # of package to get installment plans for", IsRequired=true, Name="PackageId", ParameterType="path")
    package_id: int = 0
    """
    ID # of package to get installment plans for
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None

Python GetSalesPackageDiscountsRequest DTOs

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

HTTP + XML

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

GET /sales/packages/{PackageId}/installments HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<ArrayOfSalesPackageInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <SalesPackageInstallmentPlanResponse>
    <DuePerPayment>String</DuePerPayment>
    <Fees>
      <PackageFee>
        <Amount>String</Amount>
        <CanBeWaived>false</CanBeWaived>
        <CanDuplicate>false</CanDuplicate>
        <DueUpfront>false</DueUpfront>
        <Name>String</Name>
        <OneTime>false</OneTime>
        <PayFrequencyMonths>0</PayFrequencyMonths>
        <Taxable>false</Taxable>
      </PackageFee>
    </Fees>
    <ForOnlineSale>false</ForOnlineSale>
    <Id>0</Id>
    <PaymentCount>0</PaymentCount>
  </SalesPackageInstallmentPlanResponse>
</ArrayOfSalesPackageInstallmentPlanResponse>