TicketUserServices

<back to all web services

RunRecurringChargeJobRequest

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 RecurringChargeJobSummary:
    master_enabled: Optional[bool] = None
    auto_submit_enabled: Optional[bool] = None
    dunning_enabled: Optional[bool] = None
    expire_lapsed_enabled: Optional[bool] = None
    end_of_term_revoke_enabled: Optional[bool] = None
    charge_hour: Optional[int] = None
    batch_size: Optional[int] = None
    as_of_utc: Optional[datetime.datetime] = None
    dry_run: Optional[bool] = None
    charge_live: Optional[bool] = None
    dunning_live: Optional[bool] = None
    charged: Optional[int] = None
    declined: Optional[int] = None
    ambiguous: Optional[int] = None
    skipped_already_charged: Optional[int] = None
    null_owner_charged: Optional[int] = None
    skipped_single_payment: Optional[int] = None
    expired_cards: Optional[int] = None
    end_of_term_closed: Optional[int] = None
    end_of_term_revoked: Optional[int] = None
    hard_closed: Optional[int] = None
    capped_closed: Optional[int] = None
    expired_card_notified: Optional[int] = None
    check_first: Optional[int] = None
    circuit_broken: Optional[bool] = None
    circuit_breaker_code: Optional[str] = None
    would_charge: Optional[int] = None
    would_stop_hard: Optional[int] = None
    would_stop_capped: Optional[int] = None
    would_sms: Optional[int] = None
    would_email: Optional[int] = None
    would_close: Optional[int] = None
    would_expire: Optional[int] = None
    would_end_of_term_close: Optional[int] = None
    would_end_of_term_revoke: Optional[int] = None
    sms_sent: Optional[int] = None
    emails: Optional[int] = None
    closed: Optional[int] = None
    log: Optional[List[str]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RunRecurringChargeJobRequest:
    dry_run: Optional[bool] = None
    as_of: Optional[datetime.datetime] = None

Python RunRecurringChargeJobRequest DTOs

POST /recurringPayments/run-charge HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RunRecurringChargeJobRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AsOf>0001-01-01T00:00:00</AsOf>
  <DryRun>false</DryRun>
</RunRecurringChargeJobRequest>

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

<RecurringChargeJobSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Ambiguous>0</Ambiguous>
  <AsOfUtc>0001-01-01T00:00:00</AsOfUtc>
  <AutoSubmitEnabled>false</AutoSubmitEnabled>
  <BatchSize>0</BatchSize>
  <CappedClosed>0</CappedClosed>
  <ChargeHour>0</ChargeHour>
  <ChargeLive>false</ChargeLive>
  <Charged>0</Charged>
  <CheckFirst>0</CheckFirst>
  <CircuitBreakerCode>String</CircuitBreakerCode>
  <CircuitBroken>false</CircuitBroken>
  <Closed>0</Closed>
  <Declined>0</Declined>
  <DryRun>false</DryRun>
  <DunningEnabled>false</DunningEnabled>
  <DunningLive>false</DunningLive>
  <Emails>0</Emails>
  <EndOfTermClosed>0</EndOfTermClosed>
  <EndOfTermRevokeEnabled>false</EndOfTermRevokeEnabled>
  <EndOfTermRevoked>0</EndOfTermRevoked>
  <ExpireLapsedEnabled>false</ExpireLapsedEnabled>
  <ExpiredCardNotified>0</ExpiredCardNotified>
  <ExpiredCards>0</ExpiredCards>
  <HardClosed>0</HardClosed>
  <Log xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Log>
  <MasterEnabled>false</MasterEnabled>
  <Message>String</Message>
  <NullOwnerCharged>0</NullOwnerCharged>
  <SkippedAlreadyCharged>0</SkippedAlreadyCharged>
  <SkippedSinglePayment>0</SkippedSinglePayment>
  <SmsSent>0</SmsSent>
  <StatusCode>0</StatusCode>
  <WouldCharge>0</WouldCharge>
  <WouldClose>0</WouldClose>
  <WouldEmail>0</WouldEmail>
  <WouldEndOfTermClose>0</WouldEndOfTermClose>
  <WouldEndOfTermRevoke>0</WouldEndOfTermRevoke>
  <WouldExpire>0</WouldExpire>
  <WouldSms>0</WouldSms>
  <WouldStopCapped>0</WouldStopCapped>
  <WouldStopHard>0</WouldStopHard>
</RecurringChargeJobSummary>