""" Options: Date: 2025-05-10 00:53:37 Version: 8.40 Tip: To override a DTO option, remove "#" prefix before updating BaseUrl: https://active-ewebservice.biz/aeservices30/api #GlobalNamespace: #AddServiceStackTypes: True #AddResponseStatus: False #AddImplicitVersion: #AddDescriptionAsComments: True IncludeTypes: C2BPostContractRequest.* #ExcludeTypes: #DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum #DataClass: #DataClassJson: """ 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 BaseRequest: # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header") api_key: Optional[str] = None """ This is your AIM API Key provided by Tri-Tech """ # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header") o_auth_token: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class BaseSecureRequest(BaseRequest): # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header") token: Optional[str] = None """ """ # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header") device_id: Optional[str] = None """ """ # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header") app_id: Optional[str] = None """ """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Accessory: desc: Optional[str] = None price: Decimal = decimal.Decimal(0) type: Optional[str] = None cat_num: int = 0 sku: Optional[str] = None report: Optional[bool] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class FormInput: # @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query") key: Optional[str] = None """ Field Name of the Input Field """ # @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query") value: Optional[str] = None """ Value of the Input Field. """ # @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query") encrypted: bool = False """ Whether or not the field is encryped with the C2B encryption key. """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Rate: plan_code: Optional[str] = None level: Optional[int] = None grade: Optional[str] = None down_pay: Optional[Decimal] = None mo_pay: Optional[Decimal] = None down_maint: Optional[Decimal] = None mo_maint: Optional[Decimal] = None rdf_type: Optional[str] = None contract_default_id: Optional[int] = None # @ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months") months: Optional[int] = None """ The Number of Months covered by the downpayment """ down_lease: Optional[Decimal] = None mo_lease: Optional[Decimal] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class CcInfo: # @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query") token_str: Optional[str] = None """ Token returned from processor """ # @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query") card_type: Optional[str] = None """ Card Type (VISA, MCARD, AMEX, DSCVR) """ # @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query") last_four: Optional[str] = None """ Last four of the card """ # @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query") expiration: Optional[str] = None """ Expiration Date of the Card. (MM/YY) """ # @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query") reason_on_file: Optional[str] = None """ Reason the card is on file. """ # @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query") token_pk: Optional[int] = None """ ID of the existing Token Record in AIM, if applicable """ # @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query") primary: Optional[bool] = None """ Is this the customer's primary card? Defaults to false. """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class CustomerInfo: # @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query") web_id: Optional[int] = None """ The WebId of the customer. Optional. """ # @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query") name: Optional[str] = None """ Name of the customer. """ # @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query") addr1: Optional[str] = None """ Address line 1 of the customer """ # @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query") addr2: Optional[str] = None """ Address line 2 of the customer """ # @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query") city: Optional[str] = None """ City of the customer """ # @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query") st: Optional[str] = None """ State/Province of the customer """ # @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query") zip: Optional[str] = None """ Zip code of the customer """ # @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query") country: Optional[str] = None """ Country of the customer """ # @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query") phone: Optional[str] = None """ Phone number of the customer """ # @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query") email: Optional[str] = None """ Email address of the customer. Required. """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class BaseResponse: # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body") status: Optional[BaseResponseResult] = None """ """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class C2BPostContractResponse(BaseResponse): payment_required: bool = False topic: Optional[str] = None web_ref: Optional[str] = None base_url: Optional[str] = None # @Route("/C2BPostContract", "POST, GET") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class C2BPostContractRequest(BaseSecureRequest, IReturn[C2BPostContractResponse]): """ C2BPostContractRequires active-e Contracts Service. """ # @ApiMember(DataType="integer", Description="ID of the teacher to associate the contract with.", Format="int64", Name="TeacherId", ParameterType="query") teacher_id: Optional[int] = None """ ID of the teacher to associate the contract with. """ # @ApiMember(DataType="string", Description="Used to associate the contract with a school by school name.", Name="SchoolName", ParameterType="query") school_name: Optional[str] = None """ Used to associate the contract with a school by school name. """ # @ApiMember(DataType="string", Description="Used to associate the contract with a school by the AIM School ID", Name="AIMSchoolId", ParameterType="query") aim_school_id: Optional[int] = None """ Used to associate the contract with a school by the AIM School ID """ # @ApiMember(DataType="string", Description="Used to associate the contract with a location by location code.", Name="Stloc", ParameterType="query") stloc: Optional[str] = None """ Used to associate the contract with a location by location code. """ # @ApiMember(DataType="integer", Description="ID of the instrument to associate the contract with.", Format="int64", Name="InstrumentId", ParameterType="query") instrument_id: Optional[int] = None """ ID of the instrument to associate the contract with. """ # @ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query") sku: Optional[str] = None """ """ # @ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query") desc: Optional[str] = None """ """ # @ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="query") rate_id: Optional[int] = None """ The ID from the C2BGradeGeneric object """ # @ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query") rate: Optional[Rate] = None """ """ # @ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query") accessory_id_list: Optional[List[int]] = None """ """ # @ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query") accessory_list: Optional[List[Accessory]] = None """ """ # @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query") form_input_list: Optional[List[FormInput]] = None """ """ # @ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query") cc_info: Optional[CcInfo] = None """ """ # @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query") customer_info: Optional[CustomerInfo] = None """ """ # @ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query") cus_acct: Optional[int] = None """ """ # @ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query") cat: Optional[int] = None """ """ # @ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query") sub: Optional[int] = None """ """ return_topic: Optional[bool] = None status_id: Optional[int] = None card_terminal_id: Optional[str] = None