Documentation
¶
Index ¶
- Constants
- type Account
- type AccountAgreement
- type AccountElectricityMeterPoint
- func (m *AccountElectricityMeterPoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AccountElectricityMeterPoint) MarshalBinary() ([]byte, error)
- func (m *AccountElectricityMeterPoint) UnmarshalBinary(b []byte) error
- func (m *AccountElectricityMeterPoint) Validate(formats strfmt.Registry) error
- type AccountGasMeterPoint
- type Address
- type Affiliate
- type Agreement
- type AgreementsCreated
- type BespokeElectricityUnitRate
- func (m *BespokeElectricityUnitRate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BespokeElectricityUnitRate) MarshalBinary() ([]byte, error)
- func (m *BespokeElectricityUnitRate) UnmarshalBinary(b []byte) error
- func (m *BespokeElectricityUnitRate) Validate(formats strfmt.Registry) error
- type BespokePPSTariffRates
- type BespokeRegisterRate
- type BespokeTariffRate
- type BespokeTariffRates
- type Business
- type BusinessTariffRenewal
- type Commission
- type Consumption
- type Create
- type CreateQuoteError
- type CreditScoreData
- type Deposit
- type Eco7ElectricityTariff
- type ElectricityMeterPoint
- type Emails
- type ErrorResponse
- type GasMeter
- type GasMeterPoint
- type GasTariff
- type GridSupplyPoint
- type HistoricalCharge
- type Link
- type Metadata
- type Meter
- type PSR
- type PaginatedConsumptionList
- func (m *PaginatedConsumptionList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaginatedConsumptionList) MarshalBinary() ([]byte, error)
- func (m *PaginatedConsumptionList) UnmarshalBinary(b []byte) error
- func (m *PaginatedConsumptionList) Validate(formats strfmt.Registry) error
- type PaginatedGridSupplyPointList
- func (m *PaginatedGridSupplyPointList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaginatedGridSupplyPointList) MarshalBinary() ([]byte, error)
- func (m *PaginatedGridSupplyPointList) UnmarshalBinary(b []byte) error
- func (m *PaginatedGridSupplyPointList) Validate(formats strfmt.Registry) error
- type PaginatedHistoricalChargeList
- func (m *PaginatedHistoricalChargeList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PaginatedHistoricalChargeList) MarshalBinary() ([]byte, error)
- func (m *PaginatedHistoricalChargeList) UnmarshalBinary(b []byte) error
- func (m *PaginatedHistoricalChargeList) Validate(formats strfmt.Registry) error
- type PaginatedProductsList
- type Payment
- type Product
- type ProductDualRegisterElectricityTariffsAnon
- func (m *ProductDualRegisterElectricityTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductDualRegisterElectricityTariffsAnon) MarshalBinary() ([]byte, error)
- func (m ProductDualRegisterElectricityTariffsAnon) MarshalJSON() ([]byte, error)
- func (m *ProductDualRegisterElectricityTariffsAnon) UnmarshalBinary(b []byte) error
- func (m *ProductDualRegisterElectricityTariffsAnon) UnmarshalJSON(raw []byte) error
- func (m *ProductDualRegisterElectricityTariffsAnon) Validate(formats strfmt.Registry) error
- type ProductSingleRegisterElectricityTariffsAnon
- func (m *ProductSingleRegisterElectricityTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductSingleRegisterElectricityTariffsAnon) MarshalBinary() ([]byte, error)
- func (m ProductSingleRegisterElectricityTariffsAnon) MarshalJSON() ([]byte, error)
- func (m *ProductSingleRegisterElectricityTariffsAnon) UnmarshalBinary(b []byte) error
- func (m *ProductSingleRegisterElectricityTariffsAnon) UnmarshalJSON(raw []byte) error
- func (m *ProductSingleRegisterElectricityTariffsAnon) Validate(formats strfmt.Registry) error
- type ProductSingleRegisterGasTariffsAnon
- func (m *ProductSingleRegisterGasTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductSingleRegisterGasTariffsAnon) MarshalBinary() ([]byte, error)
- func (m ProductSingleRegisterGasTariffsAnon) MarshalJSON() ([]byte, error)
- func (m *ProductSingleRegisterGasTariffsAnon) UnmarshalBinary(b []byte) error
- func (m *ProductSingleRegisterGasTariffsAnon) UnmarshalJSON(raw []byte) error
- func (m *ProductSingleRegisterGasTariffsAnon) Validate(formats strfmt.Registry) error
- type Products
- type Property
- type Quote
- type QuoteCreated
- type Register
- type SampleConsumption
- type SampleQuotes
- type StandardElectricityTariff
- func (m *StandardElectricityTariff) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StandardElectricityTariff) MarshalBinary() ([]byte, error)
- func (m *StandardElectricityTariff) UnmarshalBinary(b []byte) error
- func (m *StandardElectricityTariff) Validate(formats strfmt.Registry) error
- type SuccessResponse
- type User
- type ValidationErrors
- type ValidationOrDomainError
- func (m *ValidationOrDomainError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ValidationOrDomainError) MarshalBinary() ([]byte, error)
- func (m *ValidationOrDomainError) UnmarshalBinary(b []byte) error
- func (m *ValidationOrDomainError) Validate(formats strfmt.Registry) error
Constants ¶
const ( // BespokeElectricityUnitRatePaymentMethodDD captures enum value "DD" BespokeElectricityUnitRatePaymentMethodDD string = "DD" // BespokeElectricityUnitRatePaymentMethodNDD captures enum value "NDD" BespokeElectricityUnitRatePaymentMethodNDD string = "NDD" // BespokeElectricityUnitRatePaymentMethodPP captures enum value "PP" BespokeElectricityUnitRatePaymentMethodPP string = "PP" )
const ( // BespokeElectricityUnitRateRateTypeSTANDARD captures enum value "STANDARD" BespokeElectricityUnitRateRateTypeSTANDARD string = "STANDARD" // BespokeElectricityUnitRateRateTypeECO7DAY captures enum value "ECO7_DAY" BespokeElectricityUnitRateRateTypeECO7DAY string = "ECO7_DAY" // BespokeElectricityUnitRateRateTypeECO7NIGHT captures enum value "ECO7_NIGHT" BespokeElectricityUnitRateRateTypeECO7NIGHT string = "ECO7_NIGHT" // BespokeElectricityUnitRateRateTypeOFFPEAK captures enum value "OFF_PEAK" BespokeElectricityUnitRateRateTypeOFFPEAK string = "OFF_PEAK" // BespokeElectricityUnitRateRateTypeSUMMERPEAK captures enum value "SUMMER_PEAK" BespokeElectricityUnitRateRateTypeSUMMERPEAK string = "SUMMER_PEAK" // BespokeElectricityUnitRateRateTypeSUMMEROFFPEAK captures enum value "SUMMER_OFF_PEAK" BespokeElectricityUnitRateRateTypeSUMMEROFFPEAK string = "SUMMER_OFF_PEAK" // BespokeElectricityUnitRateRateTypeWINTERPEAK captures enum value "WINTER_PEAK" BespokeElectricityUnitRateRateTypeWINTERPEAK string = "WINTER_PEAK" // BespokeElectricityUnitRateRateTypeWINTEROFFPEAK captures enum value "WINTER_OFF_PEAK" BespokeElectricityUnitRateRateTypeWINTEROFFPEAK string = "WINTER_OFF_PEAK" // BespokeElectricityUnitRateRateTypeNUCLEARRAB captures enum value "NUCLEAR_RAB" BespokeElectricityUnitRateRateTypeNUCLEARRAB string = "NUCLEAR_RAB" // BespokeElectricityUnitRateRateTypeTNUOS captures enum value "TNUOS" BespokeElectricityUnitRateRateTypeTNUOS string = "TNUOS" // BespokeElectricityUnitRateRateTypeCAPACITYMARKET captures enum value "CAPACITY_MARKET" BespokeElectricityUnitRateRateTypeCAPACITYMARKET string = "CAPACITY_MARKET" // BespokeElectricityUnitRateRateTypeEVDEVICE captures enum value "EV_DEVICE" BespokeElectricityUnitRateRateTypeEVDEVICE string = "EV_DEVICE" )
const ( // BespokePPSTariffRatesPaymentMethodDD captures enum value "DD" BespokePPSTariffRatesPaymentMethodDD string = "DD" // BespokePPSTariffRatesPaymentMethodNDD captures enum value "NDD" BespokePPSTariffRatesPaymentMethodNDD string = "NDD" // BespokePPSTariffRatesPaymentMethodPP captures enum value "PP" BespokePPSTariffRatesPaymentMethodPP string = "PP" )
const ( // BespokeRegisterRatePaymentMethodDD captures enum value "DD" BespokeRegisterRatePaymentMethodDD string = "DD" // BespokeRegisterRatePaymentMethodNDD captures enum value "NDD" BespokeRegisterRatePaymentMethodNDD string = "NDD" // BespokeRegisterRatePaymentMethodPP captures enum value "PP" BespokeRegisterRatePaymentMethodPP string = "PP" )
const ( // BespokeRegisterRateRateTypeSTANDARD captures enum value "STANDARD" BespokeRegisterRateRateTypeSTANDARD string = "STANDARD" // BespokeRegisterRateRateTypeECO7DAY captures enum value "ECO7_DAY" BespokeRegisterRateRateTypeECO7DAY string = "ECO7_DAY" // BespokeRegisterRateRateTypeECO7NIGHT captures enum value "ECO7_NIGHT" BespokeRegisterRateRateTypeECO7NIGHT string = "ECO7_NIGHT" // BespokeRegisterRateRateTypeOFFPEAK captures enum value "OFF_PEAK" BespokeRegisterRateRateTypeOFFPEAK string = "OFF_PEAK" // BespokeRegisterRateRateTypeSUMMERPEAK captures enum value "SUMMER_PEAK" BespokeRegisterRateRateTypeSUMMERPEAK string = "SUMMER_PEAK" // BespokeRegisterRateRateTypeSUMMEROFFPEAK captures enum value "SUMMER_OFF_PEAK" BespokeRegisterRateRateTypeSUMMEROFFPEAK string = "SUMMER_OFF_PEAK" // BespokeRegisterRateRateTypeWINTERPEAK captures enum value "WINTER_PEAK" BespokeRegisterRateRateTypeWINTERPEAK string = "WINTER_PEAK" // BespokeRegisterRateRateTypeWINTEROFFPEAK captures enum value "WINTER_OFF_PEAK" BespokeRegisterRateRateTypeWINTEROFFPEAK string = "WINTER_OFF_PEAK" // BespokeRegisterRateRateTypeNUCLEARRAB captures enum value "NUCLEAR_RAB" BespokeRegisterRateRateTypeNUCLEARRAB string = "NUCLEAR_RAB" // BespokeRegisterRateRateTypeTNUOS captures enum value "TNUOS" BespokeRegisterRateRateTypeTNUOS string = "TNUOS" // BespokeRegisterRateRateTypeCAPACITYMARKET captures enum value "CAPACITY_MARKET" BespokeRegisterRateRateTypeCAPACITYMARKET string = "CAPACITY_MARKET" // BespokeRegisterRateRateTypeEVDEVICE captures enum value "EV_DEVICE" BespokeRegisterRateRateTypeEVDEVICE string = "EV_DEVICE" )
const ( // BusinessBusinessTypeSOLETRADER captures enum value "SOLE_TRADER" BusinessBusinessTypeSOLETRADER string = "SOLE_TRADER" // BusinessBusinessTypeLIMITED captures enum value "LIMITED" BusinessBusinessTypeLIMITED string = "LIMITED" // BusinessBusinessTypeCHARITY captures enum value "CHARITY" BusinessBusinessTypeCHARITY string = "CHARITY" // BusinessBusinessTypePARTNERSHIP captures enum value "PARTNERSHIP" BusinessBusinessTypePARTNERSHIP string = "PARTNERSHIP" // BusinessBusinessTypeGOVERNMENT captures enum value "GOVERNMENT" BusinessBusinessTypeGOVERNMENT string = "GOVERNMENT" )
const ( // CreateAccountTypeBUSINESS captures enum value "BUSINESS" CreateAccountTypeBUSINESS string = "BUSINESS" // CreateAccountTypeDOMESTIC captures enum value "DOMESTIC" CreateAccountTypeDOMESTIC string = "DOMESTIC" // CreateAccountTypeBUSINESSOCCUPIER captures enum value "BUSINESS OCCUPIER" CreateAccountTypeBUSINESSOCCUPIER string = "BUSINESS OCCUPIER" // CreateAccountTypeOCCUPIER captures enum value "OCCUPIER" CreateAccountTypeOCCUPIER string = "OCCUPIER" // CreateAccountTypeMANAGED captures enum value "MANAGED" CreateAccountTypeMANAGED string = "MANAGED" // CreateAccountTypePORTFOLIOLEAD captures enum value "PORTFOLIO LEAD" CreateAccountTypePORTFOLIOLEAD string = "PORTFOLIO LEAD" // CreateAccountTypeSYSTEM captures enum value "SYSTEM" CreateAccountTypeSYSTEM string = "SYSTEM" // CreateAccountTypeBUSINESSVACANT captures enum value "BUSINESS VACANT" CreateAccountTypeBUSINESSVACANT string = "BUSINESS VACANT" // CreateAccountTypeDOMESTICVACANT captures enum value "DOMESTIC VACANT" CreateAccountTypeDOMESTICVACANT string = "DOMESTIC VACANT" // CreateAccountTypeANONYMISED captures enum value "ANONYMISED" CreateAccountTypeANONYMISED string = "ANONYMISED" )
const ( // CreateBrandCodeOCTOPUSENERGY captures enum value "OCTOPUS_ENERGY" CreateBrandCodeOCTOPUSENERGY string = "OCTOPUS_ENERGY" // CreateBrandCodeCOOPENERGY captures enum value "COOP_ENERGY" CreateBrandCodeCOOPENERGY string = "COOP_ENERGY" // CreateBrandCodeLONDONPOWER captures enum value "LONDON_POWER" CreateBrandCodeLONDONPOWER string = "LONDON_POWER" )
const ( // CreateSalesChannelDIRECT captures enum value "DIRECT" CreateSalesChannelDIRECT string = "DIRECT" // CreateSalesChannelPRICECOMPARISON captures enum value "PRICE_COMPARISON" CreateSalesChannelPRICECOMPARISON string = "PRICE_COMPARISON" // CreateSalesChannelTELESALES captures enum value "TELESALES" CreateSalesChannelTELESALES string = "TELESALES" // CreateSalesChannelDIGITELESALES captures enum value "DIGI_TELESALES" CreateSalesChannelDIGITELESALES string = "DIGI_TELESALES" // CreateSalesChannelEVENTS captures enum value "EVENTS" CreateSalesChannelEVENTS string = "EVENTS" // CreateSalesChannelFIELDSALES captures enum value "FIELD_SALES" CreateSalesChannelFIELDSALES string = "FIELD_SALES" // CreateSalesChannelAGGREGATOR captures enum value "AGGREGATOR" CreateSalesChannelAGGREGATOR string = "AGGREGATOR" // CreateSalesChannelPARTNERSHIPS captures enum value "PARTNERSHIPS" CreateSalesChannelPARTNERSHIPS string = "PARTNERSHIPS" // CreateSalesChannelNEWTENANT captures enum value "NEW_TENANT" CreateSalesChannelNEWTENANT string = "NEW_TENANT" // CreateSalesChannelMOVEIN captures enum value "MOVE_IN" CreateSalesChannelMOVEIN string = "MOVE_IN" // CreateSalesChannelWORKPLACEPOPUP captures enum value "WORKPLACE_POP_UP" CreateSalesChannelWORKPLACEPOPUP string = "WORKPLACE_POP_UP" // CreateSalesChannelBROKER captures enum value "BROKER" CreateSalesChannelBROKER string = "BROKER" // CreateSalesChannelPARENTPOWER captures enum value "PARENT_POWER" CreateSalesChannelPARENTPOWER string = "PARENT_POWER" // CreateSalesChannelPEOPLEPOWER captures enum value "PEOPLE_POWER" CreateSalesChannelPEOPLEPOWER string = "PEOPLE_POWER" // CreateSalesChannelGIFTOFKIT captures enum value "GIFT_OF_KIT" CreateSalesChannelGIFTOFKIT string = "GIFT_OF_KIT" // CreateSalesChannelHIGHREFERRER captures enum value "HIGH_REFERRER" CreateSalesChannelHIGHREFERRER string = "HIGH_REFERRER" // CreateSalesChannelSUPPLIEROFLASTRESORT captures enum value "SUPPLIER_OF_LAST_RESORT" CreateSalesChannelSUPPLIEROFLASTRESORT string = "SUPPLIER_OF_LAST_RESORT" // CreateSalesChannelACQUISITION captures enum value "ACQUISITION" CreateSalesChannelACQUISITION string = "ACQUISITION" // CreateSalesChannelWORKSWITHOCTOPUS captures enum value "WORKS_WITH_OCTOPUS" CreateSalesChannelWORKSWITHOCTOPUS string = "WORKS_WITH_OCTOPUS" // CreateSalesChannelLANDLORD captures enum value "LANDLORD" CreateSalesChannelLANDLORD string = "LANDLORD" // CreateSalesChannelDEBTCOLLECTIONAGENCY captures enum value "DEBT_COLLECTION_AGENCY" CreateSalesChannelDEBTCOLLECTIONAGENCY string = "DEBT_COLLECTION_AGENCY" // CreateSalesChannelOCTOPUSTRUSTEDPARTNERS captures enum value "OCTOPUS_TRUSTED_PARTNERS" CreateSalesChannelOCTOPUSTRUSTEDPARTNERS string = "OCTOPUS_TRUSTED_PARTNERS" )
const ( // CreateSmartMeterInterestSMETS2INTERESTPRIORITY captures enum value "SMETS2_INTEREST_PRIORITY" CreateSmartMeterInterestSMETS2INTERESTPRIORITY string = "SMETS2_INTEREST_PRIORITY" // CreateSmartMeterInterestSMETS2INTERESTINTERESTED captures enum value "SMETS2_INTEREST_INTERESTED" CreateSmartMeterInterestSMETS2INTERESTINTERESTED string = "SMETS2_INTEREST_INTERESTED" // CreateSmartMeterInterestSMETS2INTERESTNOTATTHEMOMENT captures enum value "SMETS2_INTEREST_NOT_AT_THE_MOMENT" CreateSmartMeterInterestSMETS2INTERESTNOTATTHEMOMENT string = "SMETS2_INTEREST_NOT_AT_THE_MOMENT" // CreateSmartMeterInterestSMETS2INTERESTNOTINTERESTED captures enum value "SMETS2_INTEREST_NOT_INTERESTED" CreateSmartMeterInterestSMETS2INTERESTNOTINTERESTED string = "SMETS2_INTEREST_NOT_INTERESTED" )
const ( // CreateSmartMeterReadPermissionMONTHLY captures enum value "MONTHLY" CreateSmartMeterReadPermissionMONTHLY string = "MONTHLY" // CreateSmartMeterReadPermissionDAILY captures enum value "DAILY" CreateSmartMeterReadPermissionDAILY string = "DAILY" // CreateSmartMeterReadPermissionHALFHOURLY captures enum value "HALF_HOURLY" CreateSmartMeterReadPermissionHALFHOURLY string = "HALF_HOURLY" )
const ( // CreateSmartOnboardingProductTypeAGILE captures enum value "AGILE" CreateSmartOnboardingProductTypeAGILE string = "AGILE" // CreateSmartOnboardingProductTypeOCTOPUSGO captures enum value "OCTOPUS_GO" CreateSmartOnboardingProductTypeOCTOPUSGO string = "OCTOPUS_GO" // CreateSmartOnboardingProductTypeTESLAIMPORT captures enum value "TESLA_IMPORT" CreateSmartOnboardingProductTypeTESLAIMPORT string = "TESLA_IMPORT" // CreateSmartOnboardingProductTypeINTELLIGENTOCTOPUS captures enum value "INTELLIGENT_OCTOPUS" CreateSmartOnboardingProductTypeINTELLIGENTOCTOPUS string = "INTELLIGENT_OCTOPUS" // CreateSmartOnboardingProductTypeGOGREEN captures enum value "GO_GREEN" CreateSmartOnboardingProductTypeGOGREEN string = "GO_GREEN" // CreateSmartOnboardingProductTypeCOSYOCTOPUS captures enum value "COSY_OCTOPUS" CreateSmartOnboardingProductTypeCOSYOCTOPUS string = "COSY_OCTOPUS" // CreateSmartOnboardingProductTypeOCTOPUSFLUX captures enum value "OCTOPUS_FLUX" CreateSmartOnboardingProductTypeOCTOPUSFLUX string = "OCTOPUS_FLUX" // CreateSmartOnboardingProductTypeTRACKER captures enum value "TRACKER" CreateSmartOnboardingProductTypeTRACKER string = "TRACKER" // CreateSmartOnboardingProductTypeAIRAZERO captures enum value "AIRA_ZERO" CreateSmartOnboardingProductTypeAIRAZERO string = "AIRA_ZERO" )
const ( // CreateSourceCALLCENTREINBOUND captures enum value "CALL_CENTRE_INBOUND" CreateSourceCALLCENTREINBOUND string = "CALL_CENTRE_INBOUND" // CreateSourceCALLCENTREOUTBOUND captures enum value "CALL_CENTRE_OUTBOUND" CreateSourceCALLCENTREOUTBOUND string = "CALL_CENTRE_OUTBOUND" // CreateSourceINTERNET captures enum value "INTERNET" CreateSourceINTERNET string = "INTERNET" // CreateSourceFACETOFACE captures enum value "FACE_TO_FACE" CreateSourceFACETOFACE string = "FACE_TO_FACE" )
const ( // CreditScoreDataRiskBracketLOW captures enum value "LOW" CreditScoreDataRiskBracketLOW string = "LOW" // CreditScoreDataRiskBracketMID captures enum value "MID" CreditScoreDataRiskBracketMID string = "MID" // CreditScoreDataRiskBracketHIGH captures enum value "HIGH" CreditScoreDataRiskBracketHIGH string = "HIGH" // CreditScoreDataRiskBracketUNKNOWN captures enum value "UNKNOWN" CreditScoreDataRiskBracketUNKNOWN string = "UNKNOWN" )
const ( // ElectricityMeterPointMeterTypeCREDIT captures enum value "CREDIT" ElectricityMeterPointMeterTypeCREDIT string = "CREDIT" // ElectricityMeterPointMeterTypePREPAYMENT captures enum value "PREPAYMENT" ElectricityMeterPointMeterTypePREPAYMENT string = "PREPAYMENT" )
const ( // GasMeterPointMeterTypeCREDIT captures enum value "CREDIT" GasMeterPointMeterTypeCREDIT string = "CREDIT" // GasMeterPointMeterTypePREPAYMENT captures enum value "PREPAYMENT" GasMeterPointMeterTypePREPAYMENT string = "PREPAYMENT" )
const ( // PaymentMethodMONTHLYDIRECTDEBIT captures enum value "MONTHLY_DIRECT_DEBIT" PaymentMethodMONTHLYDIRECTDEBIT string = "MONTHLY_DIRECT_DEBIT" // PaymentMethodMONTHLYDIRECTPAYMENT captures enum value "MONTHLY_DIRECT_PAYMENT" PaymentMethodMONTHLYDIRECTPAYMENT string = "MONTHLY_DIRECT_PAYMENT" // PaymentMethodBILLTRIGGEREDDIRECTDEBIT captures enum value "BILL_TRIGGERED_DIRECT_DEBIT" PaymentMethodBILLTRIGGEREDDIRECTDEBIT string = "BILL_TRIGGERED_DIRECT_DEBIT" )
const ( // ProductsDirectionIMPORT captures enum value "IMPORT" ProductsDirectionIMPORT string = "IMPORT" // ProductsDirectionEXPORT captures enum value "EXPORT" ProductsDirectionEXPORT string = "EXPORT" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct {
// number
// Example: \u003caccount-number\u003e
Number string `json:"number,omitempty"`
// properties
Properties []*Property `json:"properties"`
}
Account account
swagger:model Account
func (*Account) ContextValidate ¶
ContextValidate validate this account based on the context it is used
func (*Account) MarshalBinary ¶
MarshalBinary interface implementation
func (*Account) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AccountAgreement ¶
type AccountAgreement struct {
// tariff code
// Example: E-1R-VAR-20-09-22-N
TariffCode string `json:"tariff_code,omitempty"`
// valid from
// Example: 2020-12-17T00:00:00Z
// Format: datetime
ValidFrom strfmt.DateTime `json:"valid_from,omitempty"`
// valid to
// Format: datetime
ValidTo strfmt.DateTime `json:"valid_to,omitempty"`
}
AccountAgreement account agreement
swagger:model AccountAgreement
func (*AccountAgreement) ContextValidate ¶
ContextValidate validates this account agreement based on context it is used
func (*AccountAgreement) MarshalBinary ¶
func (m *AccountAgreement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccountAgreement) UnmarshalBinary ¶
func (m *AccountAgreement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AccountElectricityMeterPoint ¶
type AccountElectricityMeterPoint struct {
// agreements
Agreements []*AccountAgreement `json:"agreements"`
// consumption standard
// Example: 2560
ConsumptionStandard int64 `json:"consumption_standard,omitempty"`
// is export
// Example: false
IsExport bool `json:"is_export,omitempty"`
// meters
Meters []*Meter `json:"meters"`
// mpan
// Example: 1000000000000
Mpan string `json:"mpan,omitempty"`
// profile class
// Example: 1
ProfileClass int64 `json:"profile_class,omitempty"`
}
AccountElectricityMeterPoint account electricity meter point
swagger:model AccountElectricityMeterPoint
func (*AccountElectricityMeterPoint) ContextValidate ¶
func (m *AccountElectricityMeterPoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this account electricity meter point based on the context it is used
func (*AccountElectricityMeterPoint) MarshalBinary ¶
func (m *AccountElectricityMeterPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccountElectricityMeterPoint) UnmarshalBinary ¶
func (m *AccountElectricityMeterPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AccountGasMeterPoint ¶
type AccountGasMeterPoint struct {
// agreements
Agreements []*AccountAgreement `json:"agreements"`
// consumption standard
// Example: 3448
ConsumptionStandard int64 `json:"consumption_standard,omitempty"`
// meters
Meters []*GasMeter `json:"meters"`
// mprn
// Example: 1234567890
Mprn string `json:"mprn,omitempty"`
}
AccountGasMeterPoint account gas meter point
swagger:model AccountGasMeterPoint
func (*AccountGasMeterPoint) ContextValidate ¶
ContextValidate validate this account gas meter point based on the context it is used
func (*AccountGasMeterPoint) MarshalBinary ¶
func (m *AccountGasMeterPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccountGasMeterPoint) UnmarshalBinary ¶
func (m *AccountGasMeterPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Address ¶
type Address struct {
// address line 1
// Required: true
// Max Length: 512
AddressLine1 *string `json:"address_line_1"`
// address line 2
// Max Length: 512
AddressLine2 string `json:"address_line_2,omitempty"`
// address line 3
// Max Length: 512
AddressLine3 string `json:"address_line_3,omitempty"`
// county
// Max Length: 512
County string `json:"county,omitempty"`
// delivery point identifier
// Max Length: 11
DeliveryPointIdentifier string `json:"delivery_point_identifier,omitempty"`
// postcode
// Required: true
// Max Length: 8
Postcode *string `json:"postcode"`
// town
// Max Length: 512
Town string `json:"town,omitempty"`
}
Address address
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validates this address based on context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Affiliate ¶
type Affiliate struct {
// affiliate link subdomain
// Max Length: 64
AffiliateLinkSubdomain string `json:"affiliate_link_subdomain,omitempty"`
// The name of an existing organization that will be used to create an account for an affiliate.
// Max Length: 128
OrganizationName string `json:"organization_name,omitempty"`
// The code of an existing signup reward referral scheme that will be used for giving credit to the created account as a signup reward.
// Max Length: 255
SignupRewardCode string `json:"signup_reward_code,omitempty"`
}
Affiliate This serializer is used to allow affiliates to pass a signup reward code when creating accounts which later will then give credit to the accounts once their payments start.
swagger:model Affiliate
func (*Affiliate) ContextValidate ¶
ContextValidate validates this affiliate based on context it is used
func (*Affiliate) MarshalBinary ¶
MarshalBinary interface implementation
func (*Affiliate) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Agreement ¶
type Agreement struct {
// Bespoke tariff rates for the new agreement, if applicable.
BespokeTariffRates []*BespokeTariffRate `json:"bespoke_tariff_rates"`
// Commission applicable to this tariff renewal.
Commission struct {
Commission
} `json:"commission,omitempty"`
// MPRN or MPAN of the meter point getting a new agreement.
// Required: true
Mpxn *string `json:"mpxn"`
// Tariff code for the new agreements.
// Required: true
TariffCode *string `json:"tariff_code"`
// Date (inclusive) the new agreement is valid from.
// Required: true
// Format: date
ValidFromDate *strfmt.Date `json:"valid_from_date"`
// Date (exclusive) the new agreement is valid to.
// Format: date
ValidToDate strfmt.Date `json:"valid_to_date,omitempty"`
}
Agreement agreement
swagger:model _Agreement
func (*Agreement) ContextValidate ¶
ContextValidate validate this agreement based on the context it is used
func (*Agreement) MarshalBinary ¶
MarshalBinary interface implementation
func (*Agreement) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AgreementsCreated ¶
type AgreementsCreated struct {
// account number
// Required: true
AccountNumber *string `json:"account_number"`
// agreements
// Required: true
Agreements []*Agreement `json:"agreements"`
}
AgreementsCreated agreements created
swagger:model AgreementsCreated
func (*AgreementsCreated) ContextValidate ¶
ContextValidate validate this agreements created based on the context it is used
func (*AgreementsCreated) MarshalBinary ¶
func (m *AgreementsCreated) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AgreementsCreated) UnmarshalBinary ¶
func (m *AgreementsCreated) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BespokeElectricityUnitRate ¶
type BespokeElectricityUnitRate struct {
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
//
// * `DD` - DD
// * `NDD` - NDD
// * `PP` - PP
// Enum: ["DD","NDD","PP"]
PaymentMethod string `json:"payment_method,omitempty"`
// The rate type of the unit rate.
//
// If the register_identifier is not provided, the rate type must be provided instead.
//
// * `STANDARD` - Standard rate (pence per kWh)
// * `ECO7_DAY` - Day (or peak) rate (pence per kWh)
// * `ECO7_NIGHT` - Night (or off-peak) rate (pence per kWh)
// * `OFF_PEAK` - Additional off-peak rate for three-rate tariffs (pence per kWh)
// * `SUMMER_PEAK` - Summer peak rate (pence per kWh) for two-rate tariffs
// * `SUMMER_OFF_PEAK` - Summer off-peak rate (pence per kWh) for two-rate tariffs
// * `WINTER_PEAK` - Winter peak rate (pence per kWh) for two-rate tariffs
// * `WINTER_OFF_PEAK` - Winter off-peak rate (pence per kWh) for two-rate tariffs
// * `NUCLEAR_RAB` - Nuclear RAB rate (pence per day) for business tariffs
// * `TNUOS` - TNUoS rate (pence per day) for business tariffs
// * `CAPACITY_MARKET` - Capacity Market rate (pence per day) for business tariffs
// * `EV_DEVICE` - Electric vehicle device rate (pence per kWh) for sub-meter billing
// Enum: ["STANDARD","ECO7_DAY","ECO7_NIGHT","OFF_PEAK","SUMMER_PEAK","SUMMER_OFF_PEAK","WINTER_PEAK","WINTER_OFF_PEAK","NUCLEAR_RAB","TNUOS","CAPACITY_MARKET","EV_DEVICE"]
RateType string `json:"rate_type,omitempty"`
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
// Required: true
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
UnitRate *string `json:"unit_rate"`
}
BespokeElectricityUnitRate bespoke electricity unit rate
swagger:model BespokeElectricityUnitRate
func (*BespokeElectricityUnitRate) ContextValidate ¶
func (m *BespokeElectricityUnitRate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this bespoke electricity unit rate based on context it is used
func (*BespokeElectricityUnitRate) MarshalBinary ¶
func (m *BespokeElectricityUnitRate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BespokeElectricityUnitRate) UnmarshalBinary ¶
func (m *BespokeElectricityUnitRate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BespokePPSTariffRates ¶
type BespokePPSTariffRates struct {
// The payment method for the rate.
//
// * `DD` - Direct Debit
// * `NDD` - Non-Direct Debit
// * `PP` - Prepayment
// Required: true
// Enum: ["DD","NDD","PP"]
PaymentMethod *string `json:"payment_method"`
// The value in pence per day of the charge (excluding VAT).
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
StandingCharge string `json:"standing_charge,omitempty"`
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
UnitRate string `json:"unit_rate,omitempty"`
// List of the value in pence per kWh of the charges (excluding VAT).
//
// For elec meters, the unit rates are provided on a per register basis in this array.
UnitRates []*BespokeElectricityUnitRate `json:"unit_rates"`
}
BespokePPSTariffRates bespoke p p s tariff rates
swagger:model BespokePPSTariffRates
func (*BespokePPSTariffRates) ContextValidate ¶
ContextValidate validate this bespoke p p s tariff rates based on the context it is used
func (*BespokePPSTariffRates) MarshalBinary ¶
func (m *BespokePPSTariffRates) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BespokePPSTariffRates) UnmarshalBinary ¶
func (m *BespokePPSTariffRates) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BespokeRegisterRate ¶
type BespokeRegisterRate struct {
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
//
// * `DD` - DD
// * `NDD` - NDD
// * `PP` - PP
// Enum: ["DD","NDD","PP"]
PaymentMethod string `json:"payment_method,omitempty"`
// The rate type of the unit rate.
//
// If the register_identifier is not provided, the rate type must be provided instead.
//
// * `STANDARD` - Standard rate (pence per kWh)
// * `ECO7_DAY` - Day (or peak) rate (pence per kWh)
// * `ECO7_NIGHT` - Night (or off-peak) rate (pence per kWh)
// * `OFF_PEAK` - Additional off-peak rate for three-rate tariffs (pence per kWh)
// * `SUMMER_PEAK` - Summer peak rate (pence per kWh) for two-rate tariffs
// * `SUMMER_OFF_PEAK` - Summer off-peak rate (pence per kWh) for two-rate tariffs
// * `WINTER_PEAK` - Winter peak rate (pence per kWh) for two-rate tariffs
// * `WINTER_OFF_PEAK` - Winter off-peak rate (pence per kWh) for two-rate tariffs
// * `NUCLEAR_RAB` - Nuclear RAB rate (pence per day) for business tariffs
// * `TNUOS` - TNUoS rate (pence per day) for business tariffs
// * `CAPACITY_MARKET` - Capacity Market rate (pence per day) for business tariffs
// * `EV_DEVICE` - Electric vehicle device rate (pence per kWh) for sub-meter billing
// Enum: ["STANDARD","ECO7_DAY","ECO7_NIGHT","OFF_PEAK","SUMMER_PEAK","SUMMER_OFF_PEAK","WINTER_PEAK","WINTER_OFF_PEAK","NUCLEAR_RAB","TNUOS","CAPACITY_MARKET","EV_DEVICE"]
RateType string `json:"rate_type,omitempty"`
// The identifier of the register to which this unit rate applies.
// Max Length: 32
RegisterIdentifier string `json:"register_identifier,omitempty"`
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
// Required: true
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
UnitRate *string `json:"unit_rate"`
}
BespokeRegisterRate bespoke register rate
swagger:model _BespokeRegisterRate
func (*BespokeRegisterRate) ContextValidate ¶
ContextValidate validates this bespoke register rate based on context it is used
func (*BespokeRegisterRate) MarshalBinary ¶
func (m *BespokeRegisterRate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BespokeRegisterRate) UnmarshalBinary ¶
func (m *BespokeRegisterRate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BespokeTariffRate ¶
type BespokeTariffRate struct {
// Meter serial number to which the bespoke tariff applies
// Required: true
// Max Length: 32
MeterSerialNumber *string `json:"meter_serial_number"`
// For elec meters, the unit rates are provided on a per register basis in this array.
Registers []*BespokeRegisterRate `json:"registers"`
// The value in pence per day of the charge (excluding VAT).
// Required: true
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
StandingCharge *string `json:"standing_charge"`
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
UnitRate string `json:"unit_rate,omitempty"`
}
BespokeTariffRate bespoke tariff rate
swagger:model _BespokeTariffRate
func (*BespokeTariffRate) ContextValidate ¶
ContextValidate validate this bespoke tariff rate based on the context it is used
func (*BespokeTariffRate) MarshalBinary ¶
func (m *BespokeTariffRate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BespokeTariffRate) UnmarshalBinary ¶
func (m *BespokeTariffRate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BespokeTariffRates ¶
type BespokeTariffRates struct {
// The value in pence per day of the charge (excluding VAT).
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
StandingCharge string `json:"standing_charge,omitempty"`
// The value in pence per kWh of the charge (excluding VAT).
//
// This field should be used for gas meters.
// Pattern: ^-?\d{0,7}(?:\.\d{0,5})?$
UnitRate string `json:"unit_rate,omitempty"`
// List of the value in pence per kWh of the charges (excluding VAT).
//
// For elec meters, the unit rates are provided on a per register basis in this array.
UnitRates []*BespokeElectricityUnitRate `json:"unit_rates"`
}
BespokeTariffRates bespoke tariff rates
swagger:model BespokeTariffRates
func (*BespokeTariffRates) ContextValidate ¶
ContextValidate validate this bespoke tariff rates based on the context it is used
func (*BespokeTariffRates) MarshalBinary ¶
func (m *BespokeTariffRates) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BespokeTariffRates) UnmarshalBinary ¶
func (m *BespokeTariffRates) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Business ¶
type Business struct {
// The estimated annual turnover
//
// In pounds £ (GBP)
// Minimum: 0
AnnualTurnover *int64 `json:"annual_turnover,omitempty"`
// * `SOLE_TRADER` - SOLE_TRADER
// * `LIMITED` - LIMITED
// * `CHARITY` - CHARITY
// * `PARTNERSHIP` - PARTNERSHIP
// * `GOVERNMENT` - GOVERNMENT
// Required: true
// Enum: ["SOLE_TRADER","LIMITED","CHARITY","PARTNERSHIP","GOVERNMENT"]
BusinessType *string `json:"business_type"`
// The head count of the business, i.e. number of staff.
// Minimum: 0
HeadCount *int64 `json:"head_count,omitempty"`
// Whether the business is exempt from paying CCL (Climate Change Levy).
// Required: true
IsCclExempt *bool `json:"is_ccl_exempt"`
// Whether the business is exempt from paying VAT.
// Required: true
IsVatExempt *bool `json:"is_vat_exempt"`
// The name of the business.
// Required: true
// Max Length: 255
Name *string `json:"name"`
// The registered number of the business.
//
// This field is required for 'LIMITED' businesses.</p>
// Max Length: 8
Number string `json:"number,omitempty"`
}
Business business
swagger:model Business
func (*Business) ContextValidate ¶
ContextValidate validates this business based on context it is used
func (*Business) MarshalBinary ¶
MarshalBinary interface implementation
func (*Business) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BusinessTariffRenewal ¶
type BusinessTariffRenewal struct {
// List of all agreements to be created to the given account.
// Required: true
Agreements []*Agreement `json:"agreements"`
}
BusinessTariffRenewal business tariff renewal
swagger:model BusinessTariffRenewal
func (*BusinessTariffRenewal) ContextValidate ¶
ContextValidate validate this business tariff renewal based on the context it is used
func (*BusinessTariffRenewal) MarshalBinary ¶
func (m *BusinessTariffRenewal) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BusinessTariffRenewal) UnmarshalBinary ¶
func (m *BusinessTariffRenewal) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Commission ¶
type Commission struct {
// Sub-domain of the affiliate link due the commission for this agreement.
// Max Length: 64
AffiliateLinkSubdomain string `json:"affiliate_link_subdomain,omitempty"`
// Name of the affiliate organisation due the commission for this agreement.
// Required: true
// Max Length: 128
AffiliateOrganisationName *string `json:"affiliate_organisation_name"`
// fixed tpi fee
// Minimum: 0
FixedTpiFee *int64 `json:"fixed_tpi_fee,omitempty"`
// Uplift in pence to be paid to the affiliate.
// Pattern: ^-?\d{0,11}(?:\.\d{0,2})?$
StandingChargeUplift string `json:"standing_charge_uplift,omitempty"`
// Uplift in pence to be paid to the affiliate.
// Required: true
// Pattern: ^-?\d{0,11}(?:\.\d{0,2})?$
UnitRateUplift *string `json:"unit_rate_uplift"`
}
Commission commission
swagger:model _Commission
func (*Commission) ContextValidate ¶
ContextValidate validates this commission based on context it is used
func (*Commission) MarshalBinary ¶
func (m *Commission) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Commission) UnmarshalBinary ¶
func (m *Commission) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Consumption ¶
type Consumption struct {
// consumption
// Required: true
// Read Only: true
Consumption float64 `json:"consumption"`
// interval end
// Required: true
// Format: date-time
IntervalEnd *strfmt.DateTime `json:"interval_end"`
// interval start
// Required: true
// Format: date-time
IntervalStart *strfmt.DateTime `json:"interval_start"`
}
Consumption consumption
swagger:model Consumption
func (*Consumption) ContextValidate ¶
ContextValidate validate this consumption based on the context it is used
func (*Consumption) MarshalBinary ¶
func (m *Consumption) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Consumption) UnmarshalBinary ¶
func (m *Consumption) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Create ¶
type Create struct {
// A unique reference to previous external account number or similar account identifier.
//
// The account reference must be in NAMESPACE-VALUE format.
// Max Length: 128
AccountReference string `json:"account_reference,omitempty"`
// * `BUSINESS` - BUSINESS
// * `DOMESTIC` - DOMESTIC
// * `BUSINESS OCCUPIER` - BUSINESS OCCUPIER
// * `OCCUPIER` - OCCUPIER
// * `MANAGED` - MANAGED
// * `PORTFOLIO LEAD` - PORTFOLIO LEAD
// * `SYSTEM` - SYSTEM
// * `BUSINESS VACANT` - BUSINESS VACANT
// * `DOMESTIC VACANT` - DOMESTIC VACANT
// * `ANONYMISED` - ANONYMISED
// Required: true
// Enum: ["BUSINESS","DOMESTIC","BUSINESS OCCUPIER","OCCUPIER","MANAGED","PORTFOLIO LEAD","SYSTEM","BUSINESS VACANT","DOMESTIC VACANT","ANONYMISED"]
AccountType *string `json:"account_type"`
// affiliate
Affiliate *Affiliate `json:"affiliate,omitempty"`
// billing address
// Required: true
BillingAddress *Address `json:"billing_address"`
// A code to specify the account should be for a particular brand.
//
// This is only required when creating an account in an instance with multiple brands and for which the requested brand is not the default brand of that instance.
//
// * `OCTOPUS_ENERGY` - OCTOPUS_ENERGY
// * `COOP_ENERGY` - COOP_ENERGY
// * `LONDON_POWER` - LONDON_POWER
// Enum: ["OCTOPUS_ENERGY","COOP_ENERGY","LONDON_POWER"]
BrandCode *string `json:"brand_code,omitempty"`
// business
Business *Business `json:"business,omitempty"`
// deposit
Deposit *Deposit `json:"deposit,omitempty"`
// At least one electricity or gas meter-point must be included. A maximum of two electricity and one gas meter-point can be included. All meter-points must be based in the Great Britain. All meter-points must belong to the same address. For an electricity meter-point, at least one of 'mpan' or 'address' must be included. At least one of 'consumption_standard' (standard tariff) or a combination of 'consumption_day' and 'consumption_night' (two-rate tariff) or 'consumption_day', 'consumption_night' and 'consumption_off_peak' (three-rate tariff) must be included depending on the type of tariff specified.
ElectricityMeterPoints []*ElectricityMeterPoint `json:"electricity_meter_points"`
// At least one electricity or gas meter-point must be included. A maximum of two electricity and one gas meter-point can be included. All meter-points must be based in the Great Britain. All meter-points must belong to the same address. For a gas meter-point, at least one of 'mprn' or 'address' must be included, as well as 'consumption_standard'.
GasMeterPoints []*GasMeterPoint `json:"gas_meter_points"`
// Whether this account is a change of tenancy at the property.
// Required: true
IsChangeOfTenancy *bool `json:"is_change_of_tenancy"`
// An array of key value pairs for storing generic metadata relating to an account.
Metadata []*Metadata `json:"metadata"`
// The payment details are required when using the method 'MONTHLY_DIRECT_DEBIT' but are optional if all the meters are of type PREPAYMENT'. The 'MONTHLY_DIRECT_PAYMENT' method is not available to all users.
Payment struct {
Payment
} `json:"payment,omitempty"`
// A preferred supply start date.
//
// Only include this field if the earliest possible supply startdate is not preferred.
// Format: date
PreferredSsd strfmt.Date `json:"preferred_ssd,omitempty"`
// A promotional code that will be applied to the account.
// Max Length: 255
PromoRewardCode string `json:"promo_reward_code,omitempty"`
// The code of an existing legacy quote created using the legacy 'CreatQuote' mutation as part of the join supplier journey for this new customer. If the quote was generated as part of an affiliate session, the affiliate link and any query parameters belonging to the session will be associated with the created account. Note: only one of 'quote_code' and 'quote_request_code' should be provided in the input.
QuoteCode string `json:"quote_code,omitempty"`
// The code of an existing quote created using the 'QuoteNewMeterPoints' mutation as part of the join supplier journey for this new customer. If the quote was generated as part of an affiliate session, the affiliate link and any query parameters belonging to the session will be associated with the created account. Note: only one of 'quote_code' and 'quote_request_code' should be provided in the input.
QuoteRequestCode string `json:"quote_request_code,omitempty"`
// A unique partner reference.
//
// The reference provided should be unique per switch.
// Required: true
// Max Length: 64
Reference *string `json:"reference"`
// The referral code of an existing account linked to a Kraken referral scheme.
// Max Length: 256
ReferralCode string `json:"referral_code,omitempty"`
// Communication delivery preference
//
// When requires_postal_comms is True, then set to POSTAL, else set to EMAIL, when not provided it will be null.
RequiresPostalComms bool `json:"requires_postal_comms,omitempty"`
// * `DIRECT` - Direct
// * `PRICE_COMPARISON` - Price comparison site
// * `TELESALES` - Telesales
// * `DIGI_TELESALES` - Digital telesales
// * `EVENTS` - Events
// * `FIELD_SALES` - Field sales
// * `AGGREGATOR` - Aggregator
// * `PARTNERSHIPS` - Partnerships
// * `NEW_TENANT` - New tenant
// * `MOVE_IN` - Move in
// * `WORKPLACE_POP_UP` - Workplace pop-up
// * `BROKER` - Broker
// * `PARENT_POWER` - Parent power
// * `PEOPLE_POWER` - People power
// * `GIFT_OF_KIT` - Gift of kit
// * `HIGH_REFERRER` - High referrer
// * `SUPPLIER_OF_LAST_RESORT` - Supplier of last resort
// * `ACQUISITION` - Acquisition
// * `WORKS_WITH_OCTOPUS` - Works with octopus
// * `LANDLORD` - Landlord
// * `DEBT_COLLECTION_AGENCY` - Debt collection agency
// * `OCTOPUS_TRUSTED_PARTNERS` - Octopus Trusted Partners
// Enum: ["DIRECT","PRICE_COMPARISON","TELESALES","DIGI_TELESALES","EVENTS","FIELD_SALES","AGGREGATOR","PARTNERSHIPS","NEW_TENANT","MOVE_IN","WORKPLACE_POP_UP","BROKER","PARENT_POWER","PEOPLE_POWER","GIFT_OF_KIT","HIGH_REFERRER","SUPPLIER_OF_LAST_RESORT","ACQUISITION","WORKS_WITH_OCTOPUS","LANDLORD","DEBT_COLLECTION_AGENCY","OCTOPUS_TRUSTED_PARTNERS"]
SalesChannel string `json:"sales_channel,omitempty"`
// An optional segmentation of the sales channel, e.g. the names of the specific price comparison site, or the telesales organisation.
// Max Length: 128
SalesSubchannel string `json:"sales_subchannel,omitempty"`
// signup reward code
// Max Length: 255
SignupRewardCode string `json:"signup_reward_code,omitempty"`
// The occupier’s interest in installing a smart meter.
//
// * `SMETS2_INTEREST_PRIORITY` - Priority
// * `SMETS2_INTEREST_INTERESTED` - Interested
// * `SMETS2_INTEREST_NOT_AT_THE_MOMENT` - No interest at the moment, ask again later
// * `SMETS2_INTEREST_NOT_INTERESTED` - Not Interested
// Enum: ["SMETS2_INTEREST_PRIORITY","SMETS2_INTEREST_INTERESTED","SMETS2_INTEREST_NOT_AT_THE_MOMENT","SMETS2_INTEREST_NOT_INTERESTED"]
SmartMeterInterest string `json:"smart_meter_interest,omitempty"`
// The read permission frequency the occupier grants to meter readings from smart meters.
//
// * `MONTHLY` - Monthly
// * `DAILY` - Daily
// * `HALF_HOURLY` - Half-hourly
// Enum: ["MONTHLY","DAILY","HALF_HOURLY"]
SmartMeterReadPermission string `json:"smart_meter_read_permission,omitempty"`
// A code to indicate which type of smart tariff the customer is meant to onboard onto.
//
// This is a restricted option. Please get in touch for information on whether this can be enabled and what the allowed options are.
//
// * `AGILE` - Agile
// * `OCTOPUS_GO` - Octopus Go
// * `TESLA_IMPORT` - Tesla Import
// * `INTELLIGENT_OCTOPUS` - Intelligent Octopus
// * `GO_GREEN` - Go Green
// * `COSY_OCTOPUS` - Cosy Octopus
// * `OCTOPUS_FLUX` - Octopus Flux
// * `TRACKER` - Tracker
// * `AIRA_ZERO` - Aira Zero
// Enum: ["AGILE","OCTOPUS_GO","TESLA_IMPORT","INTELLIGENT_OCTOPUS","GO_GREEN","COSY_OCTOPUS","OCTOPUS_FLUX","TRACKER","AIRA_ZERO"]
SmartOnboardingProductType string `json:"smart_onboarding_product_type,omitempty"`
// A datetime of when the account sale was made.
// Format: date-time
SoldAt strfmt.DateTime `json:"sold_at,omitempty"`
// * `CALL_CENTRE_INBOUND` - CALL_CENTRE_INBOUND
// * `CALL_CENTRE_OUTBOUND` - CALL_CENTRE_OUTBOUND
// * `INTERNET` - INTERNET
// * `FACE_TO_FACE` - FACE_TO_FACE
// Required: true
// Enum: ["CALL_CENTRE_INBOUND","CALL_CENTRE_OUTBOUND","INTERNET","FACE_TO_FACE"]
Source *string `json:"source"`
// users
// Required: true
Users []*User `json:"users"`
}
Create Serializer to create an account via a REST API.
Temporary to allow for legacy behaviour where uplifts do not count towards quoted amounts, which is potentially only OEGB behaviour.
swagger:model Create
func (*Create) ContextValidate ¶
ContextValidate validate this create based on the context it is used
func (*Create) MarshalBinary ¶
MarshalBinary interface implementation
func (*Create) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CreateQuoteError ¶
type CreateQuoteError struct {
// brand code
BrandCode []string `json:"brand_code"`
// business products only
BusinessProductsOnly []string `json:"business_products_only"`
// electricity meter points
ElectricityMeterPoints []string `json:"electricity_meter_points"`
// gas meter points
GasMeterPoints []string `json:"gas_meter_points"`
// product codes
ProductCodes []string `json:"product_codes"`
}
CreateQuoteError create quote error
swagger:model CreateQuoteError
func (*CreateQuoteError) ContextValidate ¶
ContextValidate validates this create quote error based on context it is used
func (*CreateQuoteError) MarshalBinary ¶
func (m *CreateQuoteError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateQuoteError) UnmarshalBinary ¶
func (m *CreateQuoteError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreditScoreData ¶
type CreditScoreData struct {
// * `LOW` - Low
// * `MID` - Medium
// * `HIGH` - High
// * `UNKNOWN` - Unknown
// Enum: ["LOW","MID","HIGH","UNKNOWN"]
RiskBracket string `json:"risk_bracket,omitempty"`
// score
// Maximum: 9999
// Minimum: 0
Score *int64 `json:"score,omitempty"`
}
CreditScoreData credit score data
swagger:model CreditScoreData
func (*CreditScoreData) ContextValidate ¶
ContextValidate validates this credit score data based on context it is used
func (*CreditScoreData) MarshalBinary ¶
func (m *CreditScoreData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreditScoreData) UnmarshalBinary ¶
func (m *CreditScoreData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Deposit ¶
type Deposit struct {
// amount
// Minimum: 1
Amount int64 `json:"amount,omitempty"`
// key
Key string `json:"key,omitempty"`
// reason
Reason string `json:"reason,omitempty"`
}
Deposit deposit
swagger:model Deposit
func (*Deposit) ContextValidate ¶
ContextValidate validates this deposit based on context it is used
func (*Deposit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Deposit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Eco7ElectricityTariff ¶
type Eco7ElectricityTariff struct {
// code
// Required: true
// Max Length: 255
Code *string `json:"code"`
// day unit rate exc vat
// Required: true
// Read Only: true
DayUnitRateExcVat *float64 `json:"day_unit_rate_exc_vat"`
// day unit rate inc vat
// Required: true
// Read Only: true
DayUnitRateIncVat *float64 `json:"day_unit_rate_inc_vat"`
// dual fuel discount exc vat
// Required: true
// Read Only: true
DualFuelDiscountExcVat float64 `json:"dual_fuel_discount_exc_vat"`
// dual fuel discount inc vat
// Required: true
// Read Only: true
DualFuelDiscountIncVat float64 `json:"dual_fuel_discount_inc_vat"`
// exit fees exc vat
// Required: true
// Read Only: true
ExitFeesExcVat int64 `json:"exit_fees_exc_vat"`
// exit fees inc vat
// Required: true
// Read Only: true
ExitFeesIncVat int64 `json:"exit_fees_inc_vat"`
// exit fees type
// Required: true
// Read Only: true
ExitFeesType string `json:"exit_fees_type"`
// links
// Required: true
// Read Only: true
Links []*Link `json:"links"`
// night unit rate exc vat
// Required: true
// Read Only: true
NightUnitRateExcVat *float64 `json:"night_unit_rate_exc_vat"`
// night unit rate inc vat
// Required: true
// Read Only: true
NightUnitRateIncVat *float64 `json:"night_unit_rate_inc_vat"`
// online discount exc vat
// Required: true
// Read Only: true
OnlineDiscountExcVat float64 `json:"online_discount_exc_vat"`
// online discount inc vat
// Required: true
// Read Only: true
OnlineDiscountIncVat float64 `json:"online_discount_inc_vat"`
// standing charge exc vat
// Required: true
// Read Only: true
StandingChargeExcVat *float64 `json:"standing_charge_exc_vat"`
// standing charge inc vat
// Required: true
// Read Only: true
StandingChargeIncVat *float64 `json:"standing_charge_inc_vat"`
}
Eco7ElectricityTariff eco7 electricity tariff
swagger:model Eco7ElectricityTariff
func (*Eco7ElectricityTariff) ContextValidate ¶
ContextValidate validate this eco7 electricity tariff based on the context it is used
func (*Eco7ElectricityTariff) MarshalBinary ¶
func (m *Eco7ElectricityTariff) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Eco7ElectricityTariff) UnmarshalBinary ¶
func (m *Eco7ElectricityTariff) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ElectricityMeterPoint ¶
type ElectricityMeterPoint struct {
// address
Address *Address `json:"address,omitempty"`
// If applicable, must contain two objects: one for direct debit bespoke and another for non-direct debit bespoke rates. Cannot be used in conjunction with 'bespoke_tariff_rates'.
// Max Items: 2
// Min Items: 0
BespokePpsTariffRates []*BespokePPSTariffRates `json:"bespoke_pps_tariff_rates"`
// A json object containing bespoke tariff rates, if applicable.
//
// Cannot be used in conjunction with 'bespoke_pps_tariff_rates'.
BespokeTariffRates struct {
BespokeTariffRates
} `json:"bespoke_tariff_rates,omitempty"`
// The expected annual consumption for the day/peak register in kWh.
//
// Required if eco7 or three-rate tariff.
// Maximum: 500000
// Minimum: 1
ConsumptionDay int64 `json:"consumption_day,omitempty"`
// The expected annual consumption for the night/off-peak register in kWh.
//
// Required if eco7 or three-rate tariff.
// Maximum: 500000
// Minimum: 0
ConsumptionNight *int64 `json:"consumption_night,omitempty"`
// The expected annual consumption for the additional off-peak register in kWh.
//
// Required if three-rate tariff.
// Maximum: 500000
// Minimum: 0
ConsumptionOffPeak *int64 `json:"consumption_off_peak,omitempty"`
// The expected annual consumption for the standard register in kWh.
//
// Required if standard tariff.
// Maximum: 500000
// Minimum: 1
ConsumptionStandard int64 `json:"consumption_standard,omitempty"`
// current supplier name
// Max Length: 255
CurrentSupplierName string `json:"current_supplier_name,omitempty"`
// current supplier tariff
// Max Length: 255
CurrentSupplierTariff string `json:"current_supplier_tariff,omitempty"`
// fixed tpi fee
// Minimum: 0
FixedTpiFee *int64 `json:"fixed_tpi_fee,omitempty"`
// Whether a smart meter is installed. The default is 'false'.
HasSmartMeter bool `json:"has_smart_meter,omitempty"`
// The default is 'CREDIT', which represents any kind of traditional credit meter or smart meter. This field is mandatory for traditional prepay meters, for which the value 'PREPAYMENT' should be used.
//
// * `CREDIT` - CREDIT
// * `PREPAYMENT` - PREPAYMENT
// Enum: ["CREDIT","PREPAYMENT"]
MeterType *string `json:"meter_type,omitempty"`
// The meter-point identifier.
// Max Length: 13
Mpan string `json:"mpan,omitempty"`
// preferred ssd
// Format: date
PreferredSsd strfmt.Date `json:"preferred_ssd,omitempty"`
// quote
// Required: true
Quote *Quote `json:"quote"`
// The ID of the market supply quoted product returned by the 'QuoteNewMeterPoints' or 'QuoteNewMeterPointsOnBespokeProducts' mutation which was selected by the customer for this meter point. Required if a 'quote_request_code' is supplied.
QuotedProductID int64 `json:"quoted_product_id,omitempty"`
// The amount to be added to the standing charge as commission (a string, pence per day).
// Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
StandingChargeUplift string `json:"standing_charge_uplift,omitempty"`
// The tariff code as stored by the supplier.
//
// Must match an available tariff on the 'sold_at' datetime for the authenticating partner. Required if no 'quote_request_code' is supplied.
// Max Length: 255
TariffCode string `json:"tariff_code,omitempty"`
// The amount to be added to the unit rate as commission (a string, pence per kWh).
// Pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
UnitRateUplift string `json:"unit_rate_uplift,omitempty"`
}
ElectricityMeterPoint electricity meter point
swagger:model ElectricityMeterPoint
func (*ElectricityMeterPoint) ContextValidate ¶
ContextValidate validate this electricity meter point based on the context it is used
func (*ElectricityMeterPoint) MarshalBinary ¶
func (m *ElectricityMeterPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ElectricityMeterPoint) UnmarshalBinary ¶
func (m *ElectricityMeterPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Emails ¶
type Emails struct {
// An array of one or more email addresses to send the email to.
// Required: true
Emails []strfmt.Email `json:"emails"`
}
Emails emails
swagger:model Emails
func (*Emails) ContextValidate ¶
ContextValidate validates this emails based on context it is used
func (*Emails) MarshalBinary ¶
MarshalBinary interface implementation
func (*Emails) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct {
// detail
// Required: true
Detail *string `json:"detail"`
}
ErrorResponse error response
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶
ContextValidate validates this error response based on context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GasMeter ¶
type GasMeter struct {
// serial number
// Example: 12345678901234
SerialNumber string `json:"serial_number,omitempty"`
}
GasMeter gas meter
swagger:model GasMeter
func (*GasMeter) ContextValidate ¶
ContextValidate validates this gas meter based on context it is used
func (*GasMeter) MarshalBinary ¶
MarshalBinary interface implementation
func (*GasMeter) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GasMeterPoint ¶
type GasMeterPoint struct {
// address
Address *Address `json:"address,omitempty"`
// If applicable, must contain two objects: one for direct debit bespoke and another for non-direct debit bespoke rates. Cannot be used in conjunction with 'bespoke_tariff_rates'.
// Max Items: 2
// Min Items: 0
BespokePpsTariffRates []*BespokePPSTariffRates `json:"bespoke_pps_tariff_rates"`
// A json object containing bespoke tariff rates, if applicable.
//
// Cannot be used in conjunction with 'bespoke_pps_tariff_rates'.
BespokeTariffRates struct {
BespokeTariffRates
} `json:"bespoke_tariff_rates,omitempty"`
// The expected annual consumption for the standard register in kWh.
//
// Required if standard tariff.
// Required: true
// Maximum: 500000
// Minimum: 1
ConsumptionStandard *int64 `json:"consumption_standard"`
// current supplier name
// Max Length: 255
CurrentSupplierName string `json:"current_supplier_name,omitempty"`
// current supplier tariff
// Max Length: 255
CurrentSupplierTariff string `json:"current_supplier_tariff,omitempty"`
// fixed tpi fee
// Minimum: 0
FixedTpiFee *int64 `json:"fixed_tpi_fee,omitempty"`
// Whether a smart meter is installed. The default is 'false'.
HasSmartMeter bool `json:"has_smart_meter,omitempty"`
// The default is 'CREDIT', which represents any kind of traditional credit meter or smart meter. This field is mandatory for traditional prepay meters, for which the value 'PREPAYMENT' should be used.
//
// * `CREDIT` - CREDIT
// * `PREPAYMENT` - PREPAYMENT
// Enum: ["CREDIT","PREPAYMENT"]
MeterType *string `json:"meter_type,omitempty"`
// The meter-point identifier.
// Max Length: 10
Mprn string `json:"mprn,omitempty"`
// preferred ssd
// Format: date
PreferredSsd strfmt.Date `json:"preferred_ssd,omitempty"`
// quote
// Required: true
Quote *Quote `json:"quote"`
// The ID of the market supply quoted product returned by the 'QuoteNewMeterPoints' or 'QuoteNewMeterPointsOnBespokeProducts' mutation which was selected by the customer for this meter point. Required if a 'quote_request_code' is supplied.
QuotedProductID int64 `json:"quoted_product_id,omitempty"`
// The amount to be added to the standing charge as commission (a string, pence per day).
// Pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
StandingChargeUplift string `json:"standing_charge_uplift,omitempty"`
// The tariff code as stored by the supplier.
//
// Must match an available tariff on the 'sold_at' datetime for the authenticating partner. Required if no 'quote_request_code' is supplied.
// Max Length: 255
TariffCode string `json:"tariff_code,omitempty"`
// The amount to be added to the unit rate as commission (a string, pence per kWh).
// Pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
UnitRateUplift string `json:"unit_rate_uplift,omitempty"`
}
GasMeterPoint gas meter point
swagger:model GasMeterPoint
func (*GasMeterPoint) ContextValidate ¶
ContextValidate validate this gas meter point based on the context it is used
func (*GasMeterPoint) MarshalBinary ¶
func (m *GasMeterPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GasMeterPoint) UnmarshalBinary ¶
func (m *GasMeterPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GasTariff ¶
type GasTariff struct {
// code
// Required: true
// Max Length: 255
Code *string `json:"code"`
// dual fuel discount exc vat
// Required: true
// Read Only: true
DualFuelDiscountExcVat float64 `json:"dual_fuel_discount_exc_vat"`
// dual fuel discount inc vat
// Required: true
// Read Only: true
DualFuelDiscountIncVat float64 `json:"dual_fuel_discount_inc_vat"`
// exit fees exc vat
// Required: true
// Read Only: true
ExitFeesExcVat int64 `json:"exit_fees_exc_vat"`
// exit fees inc vat
// Required: true
// Read Only: true
ExitFeesIncVat int64 `json:"exit_fees_inc_vat"`
// exit fees type
// Required: true
// Read Only: true
ExitFeesType string `json:"exit_fees_type"`
// links
// Required: true
// Read Only: true
Links []*Link `json:"links"`
// online discount exc vat
// Required: true
// Read Only: true
OnlineDiscountExcVat float64 `json:"online_discount_exc_vat"`
// online discount inc vat
// Required: true
// Read Only: true
OnlineDiscountIncVat float64 `json:"online_discount_inc_vat"`
// standard unit rate exc vat
// Required: true
// Read Only: true
StandardUnitRateExcVat *float64 `json:"standard_unit_rate_exc_vat"`
// standard unit rate inc vat
// Required: true
// Read Only: true
StandardUnitRateIncVat *float64 `json:"standard_unit_rate_inc_vat"`
// standing charge exc vat
// Required: true
// Read Only: true
StandingChargeExcVat *float64 `json:"standing_charge_exc_vat"`
// standing charge inc vat
// Required: true
// Read Only: true
StandingChargeIncVat *float64 `json:"standing_charge_inc_vat"`
}
GasTariff gas tariff
swagger:model GasTariff
func (*GasTariff) ContextValidate ¶
ContextValidate validate this gas tariff based on the context it is used
func (*GasTariff) MarshalBinary ¶
MarshalBinary interface implementation
func (*GasTariff) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type GridSupplyPoint ¶
type GridSupplyPoint struct {
// group id
// Required: true
GroupID *string `json:"group_id"`
}
GridSupplyPoint grid supply point
swagger:model GridSupplyPoint
func (*GridSupplyPoint) ContextValidate ¶
ContextValidate validates this grid supply point based on context it is used
func (*GridSupplyPoint) MarshalBinary ¶
func (m *GridSupplyPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GridSupplyPoint) UnmarshalBinary ¶
func (m *GridSupplyPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HistoricalCharge ¶
type HistoricalCharge struct {
// payment method
// Required: true
// Read Only: true
PaymentMethod *string `json:"payment_method"`
// valid from
// Required: true
// Read Only: true
// Format: date-time
ValidFrom *strfmt.DateTime `json:"valid_from"`
// valid to
// Required: true
// Read Only: true
// Format: date-time
ValidTo *strfmt.DateTime `json:"valid_to"`
// value exc vat
// Required: true
// Read Only: true
ValueExcVat float64 `json:"value_exc_vat"`
// value inc vat
// Required: true
// Read Only: true
ValueIncVat float64 `json:"value_inc_vat"`
}
HistoricalCharge historical charge
swagger:model HistoricalCharge
func (*HistoricalCharge) ContextValidate ¶
ContextValidate validate this historical charge based on the context it is used
func (*HistoricalCharge) MarshalBinary ¶
func (m *HistoricalCharge) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoricalCharge) UnmarshalBinary ¶
func (m *HistoricalCharge) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Link ¶
type Link struct {
// href
// Required: true
Href *string `json:"href"`
// method
// Required: true
Method *string `json:"method"`
// rel
// Required: true
Rel *string `json:"rel"`
}
Link link
swagger:model Link
func (*Link) ContextValidate ¶
ContextValidate validates this link based on context it is used
func (*Link) MarshalBinary ¶
MarshalBinary interface implementation
func (*Link) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Metadata ¶
type Metadata struct {
// Key on which the metadata will be stored.
// Required: true
// Max Length: 1024
Key *string `json:"key"`
// A json object containing any arbitrary piece of data to store in relation to the account.
// Required: true
Value interface{} `json:"value"`
}
Metadata metadata
swagger:model Metadata
func (*Metadata) ContextValidate ¶
ContextValidate validates this metadata based on context it is used
func (*Metadata) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metadata) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Meter ¶
type Meter struct {
// registers
Registers []*Register `json:"registers"`
// serial number
// Example: 1111111111
SerialNumber string `json:"serial_number,omitempty"`
}
Meter meter
swagger:model Meter
func (*Meter) ContextValidate ¶
ContextValidate validate this meter based on the context it is used
func (*Meter) MarshalBinary ¶
MarshalBinary interface implementation
func (*Meter) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PSR ¶
type PSR struct {
// If true, indicates that the user should be signed up to the PSR but the categories are unknown. Therefore the user requires contacting to determine the categories.
RequiresSignup bool `json:"requires_signup,omitempty"`
}
PSR p s r
swagger:model PSR
func (*PSR) ContextValidate ¶
ContextValidate validates this p s r based on context it is used
func (*PSR) MarshalBinary ¶
MarshalBinary interface implementation
func (*PSR) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PaginatedConsumptionList ¶
type PaginatedConsumptionList struct {
// count
// Example: 123
// Required: true
Count *int64 `json:"count"`
// next
// Example: https://api.octopus.energy/v1/electricity-meter-points/S1212345678901/meters/Z16N389556/consumption/?page=4
// Format: uri
Next *strfmt.URI `json:"next,omitempty"`
// previous
// Example: https://api.octopus.energy/v1/electricity-meter-points/S1212345678901/meters/Z16N389556/consumption/?page=2
// Format: uri
Previous *strfmt.URI `json:"previous,omitempty"`
// results
// Required: true
Results []*Consumption `json:"results"`
}
PaginatedConsumptionList paginated consumption list
swagger:model PaginatedConsumptionList
func (*PaginatedConsumptionList) ContextValidate ¶
func (m *PaginatedConsumptionList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this paginated consumption list based on the context it is used
func (*PaginatedConsumptionList) MarshalBinary ¶
func (m *PaginatedConsumptionList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedConsumptionList) UnmarshalBinary ¶
func (m *PaginatedConsumptionList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedGridSupplyPointList ¶
type PaginatedGridSupplyPointList struct {
// count
// Example: 123
// Required: true
Count *int64 `json:"count"`
// next
// Example: https://api.octopus.energy/v1/industry/grid-supply-points/?page=4
// Format: uri
Next *strfmt.URI `json:"next,omitempty"`
// previous
// Example: https://api.octopus.energy/v1/industry/grid-supply-points/?page=2
// Format: uri
Previous *strfmt.URI `json:"previous,omitempty"`
// results
// Required: true
Results []*GridSupplyPoint `json:"results"`
}
PaginatedGridSupplyPointList paginated grid supply point list
swagger:model PaginatedGridSupplyPointList
func (*PaginatedGridSupplyPointList) ContextValidate ¶
func (m *PaginatedGridSupplyPointList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this paginated grid supply point list based on the context it is used
func (*PaginatedGridSupplyPointList) MarshalBinary ¶
func (m *PaginatedGridSupplyPointList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedGridSupplyPointList) UnmarshalBinary ¶
func (m *PaginatedGridSupplyPointList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedHistoricalChargeList ¶
type PaginatedHistoricalChargeList struct {
// count
// Example: 123
// Required: true
Count *int64 `json:"count"`
// next
// Example: https://api.octopus.energy/v1/products/VAR-17-01-11/electricity-tariffs/E-1R-VAR-17-01-11-A/day-unit-rates/?page=4
// Format: uri
Next *strfmt.URI `json:"next,omitempty"`
// previous
// Example: https://api.octopus.energy/v1/products/VAR-17-01-11/electricity-tariffs/E-1R-VAR-17-01-11-A/day-unit-rates/?page=2
// Format: uri
Previous *strfmt.URI `json:"previous,omitempty"`
// results
// Required: true
Results []*HistoricalCharge `json:"results"`
}
PaginatedHistoricalChargeList paginated historical charge list
swagger:model PaginatedHistoricalChargeList
func (*PaginatedHistoricalChargeList) ContextValidate ¶
func (m *PaginatedHistoricalChargeList) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this paginated historical charge list based on the context it is used
func (*PaginatedHistoricalChargeList) MarshalBinary ¶
func (m *PaginatedHistoricalChargeList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedHistoricalChargeList) UnmarshalBinary ¶
func (m *PaginatedHistoricalChargeList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PaginatedProductsList ¶
type PaginatedProductsList struct {
// count
// Example: 123
// Required: true
Count *int64 `json:"count"`
// next
// Example: https://api.octopus.energy/v1/products/?page=4
// Format: uri
Next *strfmt.URI `json:"next,omitempty"`
// previous
// Example: https://api.octopus.energy/v1/products/?page=2
// Format: uri
Previous *strfmt.URI `json:"previous,omitempty"`
// results
// Required: true
Results []*Products `json:"results"`
}
PaginatedProductsList paginated products list
swagger:model PaginatedProductsList
func (*PaginatedProductsList) ContextValidate ¶
ContextValidate validate this paginated products list based on the context it is used
func (*PaginatedProductsList) MarshalBinary ¶
func (m *PaginatedProductsList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PaginatedProductsList) UnmarshalBinary ¶
func (m *PaginatedProductsList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Payment ¶
type Payment struct {
// The name associated with the bank account.
// Max Length: 255
// Min Length: 3
AccountName string `json:"account_name,omitempty"`
// The bank account number.
AccountNumber string `json:"account_number,omitempty"`
// The bank account sort code.
AccountSortCode string `json:"account_sort_code,omitempty"`
// The number of days to delay the payment for a bill triggered schedule.
// Maximum: 90
// Minimum: 5
DelayDays int64 `json:"delay_days,omitempty"`
// * `MONTHLY_DIRECT_DEBIT` - Monthly Direct Debit
// * `MONTHLY_DIRECT_PAYMENT` - POROB schedule, payment initiated by the customer
// * `BILL_TRIGGERED_DIRECT_DEBIT` - POROB Direct Debit Schedule
// Required: true
// Enum: ["MONTHLY_DIRECT_DEBIT","MONTHLY_DIRECT_PAYMENT","BILL_TRIGGERED_DIRECT_DEBIT"]
Method *string `json:"method"`
// The preferred day of the month for the payment request.
//
// Only required for 'MONTHLY_DIRECT_DEBIT' schedules.
// Maximum: 28
// Minimum: 1
PaymentDay int64 `json:"payment_day,omitempty"`
}
Payment payment
swagger:model Payment
func (*Payment) ContextValidate ¶
ContextValidate validates this payment based on context it is used
func (*Payment) MarshalBinary ¶
MarshalBinary interface implementation
func (*Payment) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Product ¶
type Product struct {
// available from
// Required: true
// Format: date-time
AvailableFrom *strfmt.DateTime `json:"available_from"`
// available to
// Format: date-time
AvailableTo *strfmt.DateTime `json:"available_to,omitempty"`
// brand
// Required: true
// Read Only: true
Brand string `json:"brand"`
// code
// Required: true
// Max Length: 128
Code *string `json:"code"`
// This will be shown to customers during sign-up
// Required: true
Description *string `json:"description"`
// This name will be shown to customers during sign-up
// Required: true
// Max Length: 255
DisplayName *string `json:"display_name"`
// dual register electricity tariffs
// Required: true
// Read Only: true
DualRegisterElectricityTariffs map[string]map[string]ProductDualRegisterElectricityTariffsAnon `json:"dual_register_electricity_tariffs"`
// full name
// Required: true
// Max Length: 255
FullName *string `json:"full_name"`
// Is a business product?
IsBusiness bool `json:"is_business,omitempty"`
// Is a green product?
IsGreen bool `json:"is_green,omitempty"`
// is prepay
IsPrepay bool `json:"is_prepay,omitempty"`
// is restricted
// Required: true
// Read Only: true
IsRestricted bool `json:"is_restricted"`
// Is a tracker product?
IsTracker bool `json:"is_tracker,omitempty"`
// Is variable?
IsVariable bool `json:"is_variable,omitempty"`
// Historical charges can be browsed using the provided URLs.
// Required: true
// Read Only: true
Links []*Link `json:"links"`
// sample consumption
// Required: true
// Read Only: true
SampleConsumption struct {
SampleConsumption
} `json:"sample_consumption"`
// sample quotes
// Required: true
// Read Only: true
SampleQuotes struct {
SampleQuotes
} `json:"sample_quotes"`
// single register electricity tariffs
// Required: true
// Read Only: true
SingleRegisterElectricityTariffs map[string]map[string]ProductSingleRegisterElectricityTariffsAnon `json:"single_register_electricity_tariffs"`
// single register gas tariffs
// Required: true
// Read Only: true
SingleRegisterGasTariffs map[string]map[string]ProductSingleRegisterGasTariffsAnon `json:"single_register_gas_tariffs"`
// tariffs active at
// Required: true
// Read Only: true
// Format: date-time
TariffsActiveAt strfmt.DateTime `json:"tariffs_active_at"`
// Duration of agreements using this product in months
// Maximum: 2.147483647e+09
// Minimum: 0
Term *int64 `json:"term,omitempty"`
}
Product product
swagger:model Product
func (*Product) ContextValidate ¶
ContextValidate validate this product based on the context it is used
func (*Product) MarshalBinary ¶
MarshalBinary interface implementation
func (*Product) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProductDualRegisterElectricityTariffsAnon ¶
type ProductDualRegisterElectricityTariffsAnon struct {
Eco7ElectricityTariff
}
ProductDualRegisterElectricityTariffsAnon Tariffs per payment method (DIRECT_DEBIT_MONTHLY, DIRECT_DEBIT_QUARTERLY, POROB, PREPAYMENT, VARYING)
swagger:model ProductDualRegisterElectricityTariffsAnon
func (*ProductDualRegisterElectricityTariffsAnon) ContextValidate ¶
func (m *ProductDualRegisterElectricityTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product dual register electricity tariffs anon based on the context it is used
func (*ProductDualRegisterElectricityTariffsAnon) MarshalBinary ¶
func (m *ProductDualRegisterElectricityTariffsAnon) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ProductDualRegisterElectricityTariffsAnon) MarshalJSON ¶
func (m ProductDualRegisterElectricityTariffsAnon) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ProductDualRegisterElectricityTariffsAnon) UnmarshalBinary ¶
func (m *ProductDualRegisterElectricityTariffsAnon) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ProductDualRegisterElectricityTariffsAnon) UnmarshalJSON ¶
func (m *ProductDualRegisterElectricityTariffsAnon) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ProductSingleRegisterElectricityTariffsAnon ¶
type ProductSingleRegisterElectricityTariffsAnon struct {
StandardElectricityTariff
}
ProductSingleRegisterElectricityTariffsAnon Tariffs per payment method (DIRECT_DEBIT_MONTHLY, DIRECT_DEBIT_QUARTERLY, POROB, PREPAYMENT, VARYING)
swagger:model ProductSingleRegisterElectricityTariffsAnon
func (*ProductSingleRegisterElectricityTariffsAnon) ContextValidate ¶
func (m *ProductSingleRegisterElectricityTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product single register electricity tariffs anon based on the context it is used
func (*ProductSingleRegisterElectricityTariffsAnon) MarshalBinary ¶
func (m *ProductSingleRegisterElectricityTariffsAnon) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ProductSingleRegisterElectricityTariffsAnon) MarshalJSON ¶
func (m ProductSingleRegisterElectricityTariffsAnon) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ProductSingleRegisterElectricityTariffsAnon) UnmarshalBinary ¶
func (m *ProductSingleRegisterElectricityTariffsAnon) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ProductSingleRegisterElectricityTariffsAnon) UnmarshalJSON ¶
func (m *ProductSingleRegisterElectricityTariffsAnon) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type ProductSingleRegisterGasTariffsAnon ¶
type ProductSingleRegisterGasTariffsAnon struct {
GasTariff
}
ProductSingleRegisterGasTariffsAnon Tariffs per payment method (DIRECT_DEBIT_MONTHLY, DIRECT_DEBIT_QUARTERLY, POROB, PREPAYMENT, VARYING)
swagger:model ProductSingleRegisterGasTariffsAnon
func (*ProductSingleRegisterGasTariffsAnon) ContextValidate ¶
func (m *ProductSingleRegisterGasTariffsAnon) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product single register gas tariffs anon based on the context it is used
func (*ProductSingleRegisterGasTariffsAnon) MarshalBinary ¶
func (m *ProductSingleRegisterGasTariffsAnon) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ProductSingleRegisterGasTariffsAnon) MarshalJSON ¶
func (m ProductSingleRegisterGasTariffsAnon) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*ProductSingleRegisterGasTariffsAnon) UnmarshalBinary ¶
func (m *ProductSingleRegisterGasTariffsAnon) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ProductSingleRegisterGasTariffsAnon) UnmarshalJSON ¶
func (m *ProductSingleRegisterGasTariffsAnon) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Products ¶
type Products struct {
// available from
// Required: true
// Format: date-time
AvailableFrom *strfmt.DateTime `json:"available_from"`
// available to
// Format: date-time
AvailableTo *strfmt.DateTime `json:"available_to,omitempty"`
// brand
// Required: true
// Read Only: true
Brand string `json:"brand"`
// code
// Required: true
// Max Length: 128
Code *string `json:"code"`
// This will be shown to customers during sign-up
// Required: true
Description *string `json:"description"`
// * `IMPORT` - Import
// * `EXPORT` - Export
// Enum: ["IMPORT","EXPORT"]
Direction string `json:"direction,omitempty"`
// This name will be shown to customers during sign-up
// Required: true
// Max Length: 255
DisplayName *string `json:"display_name"`
// full name
// Required: true
// Max Length: 255
FullName *string `json:"full_name"`
// Is a business product?
IsBusiness bool `json:"is_business,omitempty"`
// Is a green product?
IsGreen bool `json:"is_green,omitempty"`
// is prepay
IsPrepay bool `json:"is_prepay,omitempty"`
// is restricted
// Required: true
// Read Only: true
IsRestricted bool `json:"is_restricted"`
// Is a tracker product?
IsTracker bool `json:"is_tracker,omitempty"`
// Is variable?
IsVariable bool `json:"is_variable,omitempty"`
// Historical charges can be browsed using the provided URLs.
// Required: true
// Read Only: true
Links []*Link `json:"links"`
// Duration of agreements using this product in months
// Maximum: 2.147483647e+09
// Minimum: 0
Term *int64 `json:"term,omitempty"`
}
Products products
swagger:model Products
func (*Products) ContextValidate ¶
ContextValidate validate this products based on the context it is used
func (*Products) MarshalBinary ¶
MarshalBinary interface implementation
func (*Products) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Property ¶
type Property struct {
// address line 1
// Example: 10 Downing Street
AddressLine1 string `json:"address_line_1,omitempty"`
// address line 2
AddressLine2 string `json:"address_line_2,omitempty"`
// address line 3
AddressLine3 string `json:"address_line_3,omitempty"`
// county
County string `json:"county,omitempty"`
// electricity meter points
ElectricityMeterPoints []*AccountElectricityMeterPoint `json:"electricity_meter_points"`
// gas meter points
GasMeterPoints []*AccountGasMeterPoint `json:"gas_meter_points"`
// id
// Example: 1234567
ID int64 `json:"id,omitempty"`
// moved in at
// Example: 2020-11-30T00:00:00Z
// Format: datetime
MovedInAt strfmt.DateTime `json:"moved_in_at,omitempty"`
// moved out at
// Format: datetime
MovedOutAt strfmt.DateTime `json:"moved_out_at,omitempty"`
// postcode
// Example: W1 1AA
Postcode string `json:"postcode,omitempty"`
// town
// Example: LONDON
Town string `json:"town,omitempty"`
}
Property property
swagger:model Property
func (*Property) ContextValidate ¶
ContextValidate validate this property based on the context it is used
func (*Property) MarshalBinary ¶
MarshalBinary interface implementation
func (*Property) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Quote ¶
type Quote struct {
// The estimated annual payment for this meter-point based on consumption.
//
// This value must be provided in pence. For business quotes, the price is exclusive of VAT, while for non-business quotes, it should be inclusive of VAT.
// Required: true
// Minimum: 0
AnnualPayment *int64 `json:"annual_payment"`
}
Quote quote
swagger:model Quote
func (*Quote) ContextValidate ¶
ContextValidate validates this quote based on context it is used
func (*Quote) MarshalBinary ¶
MarshalBinary interface implementation
func (*Quote) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type QuoteCreated ¶
type QuoteCreated struct {
// code
// Required: true
Code *string `json:"code"`
// gsp
// Required: true
Gsp *string `json:"gsp"`
// products
// Required: true
// Read Only: true
Products []interface{} `json:"products"`
}
QuoteCreated quote created
swagger:model QuoteCreated
func (*QuoteCreated) ContextValidate ¶
ContextValidate validate this quote created based on the context it is used
func (*QuoteCreated) MarshalBinary ¶
func (m *QuoteCreated) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QuoteCreated) UnmarshalBinary ¶
func (m *QuoteCreated) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Register ¶
type Register struct {
// identifier
// Example: 1
Identifier string `json:"identifier,omitempty"`
// is settlement register
// Example: true
IsSettlementRegister bool `json:"is_settlement_register,omitempty"`
// rate
// Example: STANDARD
Rate string `json:"rate,omitempty"`
}
Register register
swagger:model Register
func (*Register) ContextValidate ¶
ContextValidate validates this register based on context it is used
func (*Register) MarshalBinary ¶
MarshalBinary interface implementation
func (*Register) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SampleConsumption ¶
type SampleConsumption struct {
// Consumption type
// Required: true
DualFuelDualRate map[string]int64 `json:"dual_fuel_dual_rate"`
// Consumption type
// Required: true
DualFuelSingleRate map[string]int64 `json:"dual_fuel_single_rate"`
// Consumption type
// Required: true
ElectricityDualRate map[string]int64 `json:"electricity_dual_rate"`
// Consumption type
// Required: true
ElectricitySingleRate map[string]int64 `json:"electricity_single_rate"`
}
SampleConsumption sample consumption
swagger:model SampleConsumption
func (*SampleConsumption) ContextValidate ¶
ContextValidate validates this sample consumption based on context it is used
func (*SampleConsumption) MarshalBinary ¶
func (m *SampleConsumption) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SampleConsumption) UnmarshalBinary ¶
func (m *SampleConsumption) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SampleQuotes ¶
type SampleQuotes struct {
// Annual cost (inc or exc)
// Required: true
DualFuelDualRate map[string]int64 `json:"dual_fuel_dual_rate"`
// Annual cost (inc or exc)
// Required: true
DualFuelSingleRate map[string]int64 `json:"dual_fuel_single_rate"`
// Annual cost (inc or exc)
// Required: true
ElectricityDualRate map[string]int64 `json:"electricity_dual_rate"`
// Annual cost (inc or exc)
// Required: true
ElectricitySingleRate map[string]int64 `json:"electricity_single_rate"`
}
SampleQuotes sample quotes
swagger:model SampleQuotes
func (*SampleQuotes) ContextValidate ¶
ContextValidate validates this sample quotes based on context it is used
func (*SampleQuotes) MarshalBinary ¶
func (m *SampleQuotes) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SampleQuotes) UnmarshalBinary ¶
func (m *SampleQuotes) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StandardElectricityTariff ¶
type StandardElectricityTariff struct {
// code
// Required: true
// Max Length: 255
Code *string `json:"code"`
// dual fuel discount exc vat
// Required: true
// Read Only: true
DualFuelDiscountExcVat float64 `json:"dual_fuel_discount_exc_vat"`
// dual fuel discount inc vat
// Required: true
// Read Only: true
DualFuelDiscountIncVat float64 `json:"dual_fuel_discount_inc_vat"`
// exit fees exc vat
// Required: true
// Read Only: true
ExitFeesExcVat int64 `json:"exit_fees_exc_vat"`
// exit fees inc vat
// Required: true
// Read Only: true
ExitFeesIncVat int64 `json:"exit_fees_inc_vat"`
// exit fees type
// Required: true
// Read Only: true
ExitFeesType string `json:"exit_fees_type"`
// links
// Required: true
// Read Only: true
Links []*Link `json:"links"`
// online discount exc vat
// Required: true
// Read Only: true
OnlineDiscountExcVat float64 `json:"online_discount_exc_vat"`
// online discount inc vat
// Required: true
// Read Only: true
OnlineDiscountIncVat float64 `json:"online_discount_inc_vat"`
// standard unit rate exc vat
// Required: true
// Read Only: true
StandardUnitRateExcVat *float64 `json:"standard_unit_rate_exc_vat"`
// standard unit rate inc vat
// Required: true
// Read Only: true
StandardUnitRateIncVat *float64 `json:"standard_unit_rate_inc_vat"`
// standing charge exc vat
// Required: true
// Read Only: true
StandingChargeExcVat *float64 `json:"standing_charge_exc_vat"`
// standing charge inc vat
// Required: true
// Read Only: true
StandingChargeIncVat *float64 `json:"standing_charge_inc_vat"`
}
StandardElectricityTariff standard electricity tariff
swagger:model StandardElectricityTariff
func (*StandardElectricityTariff) ContextValidate ¶
func (m *StandardElectricityTariff) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this standard electricity tariff based on the context it is used
func (*StandardElectricityTariff) MarshalBinary ¶
func (m *StandardElectricityTariff) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StandardElectricityTariff) UnmarshalBinary ¶
func (m *StandardElectricityTariff) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SuccessResponse ¶
type SuccessResponse struct {
// Number of the newly created account
// Required: true
Number *string `json:"number"`
}
SuccessResponse success response
swagger:model SuccessResponse
func (*SuccessResponse) ContextValidate ¶
ContextValidate validates this success response based on context it is used
func (*SuccessResponse) MarshalBinary ¶
func (m *SuccessResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SuccessResponse) UnmarshalBinary ¶
func (m *SuccessResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
type User struct {
// credit score data
CreditScoreData *CreditScoreData `json:"credit_score_data,omitempty"`
// date of birth
// Format: date
DateOfBirth strfmt.Date `json:"date_of_birth,omitempty"`
// Cannot already be in use for an existing account.
// Required: true
// Max Length: 512
// Format: email
Email *strfmt.Email `json:"email"`
// family name
// Required: true
// Max Length: 255
FamilyName *string `json:"family_name"`
// given name
// Required: true
// Max Length: 255
GivenName *string `json:"given_name"`
// landline
// Max Length: 64
Landline string `json:"landline,omitempty"`
// mobile
// Max Length: 64
Mobile string `json:"mobile,omitempty"`
// opted in for marketing
// Required: true
OptedInForMarketing *bool `json:"opted_in_for_marketing"`
// opted in to third parties
OptedInToThirdParties *bool `json:"opted_in_to_third_parties,omitempty"`
// Priority Services Register details for the user
Psr struct {
PSR
} `json:"psr,omitempty"`
// title
// Max Length: 255
Title string `json:"title,omitempty"`
}
User user
swagger:model User
func (*User) ContextValidate ¶
ContextValidate validate this user based on the context it is used
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ValidationErrors ¶
type ValidationErrors struct {
// emails
// Required: true
Emails interface{} `json:"emails"`
}
ValidationErrors validation errors
swagger:model ValidationErrors
func (*ValidationErrors) ContextValidate ¶
ContextValidate validates this validation errors based on context it is used
func (*ValidationErrors) MarshalBinary ¶
func (m *ValidationErrors) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ValidationErrors) UnmarshalBinary ¶
func (m *ValidationErrors) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ValidationOrDomainError ¶
type ValidationOrDomainError struct {
// errors
// Required: true
Errors []string `json:"errors"`
}
ValidationOrDomainError validation or domain error
swagger:model ValidationOrDomainError
func (*ValidationOrDomainError) ContextValidate ¶
func (m *ValidationOrDomainError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this validation or domain error based on context it is used
func (*ValidationOrDomainError) MarshalBinary ¶
func (m *ValidationOrDomainError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ValidationOrDomainError) UnmarshalBinary ¶
func (m *ValidationOrDomainError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- account.go
- account_agreement.go
- account_electricity_meter_point.go
- account_gas_meter_point.go
- address.go
- affiliate.go
- agreement.go
- agreements_created.go
- bespoke_electricity_unit_rate.go
- bespoke_p_p_s_tariff_rates.go
- bespoke_register_rate.go
- bespoke_tariff_rate.go
- bespoke_tariff_rates.go
- business.go
- business_tariff_renewal.go
- commission.go
- consumption.go
- create.go
- create_quote_error.go
- credit_score_data.go
- deposit.go
- eco7_electricity_tariff.go
- electricity_meter_point.go
- emails.go
- error_response.go
- gas_meter.go
- gas_meter_point.go
- gas_tariff.go
- grid_supply_point.go
- historical_charge.go
- link.go
- metadata.go
- meter.go
- p_s_r.go
- paginated_consumption_list.go
- paginated_grid_supply_point_list.go
- paginated_historical_charge_list.go
- paginated_products_list.go
- payment.go
- product.go
- products.go
- property.go
- quote.go
- quote_created.go
- register.go
- sample_consumption.go
- sample_quotes.go
- standard_electricity_tariff.go
- success_response.go
- user.go
- validation_errors.go
- validation_or_domain_error.go