Communication API v3 (Alpha)¶

Contacts¶

Manage contact.

GetContact¶

Get a specific contact.

Input: GetContactRequest¶

Output: Contact¶

Information on how to address a legal entity. A legal entity can be either a natural person or a company with an optional contact Natural Person: Must provide person Company: Must provide company

CreateContact¶

Create or update a contact.

Input: CreateContactRequest¶

Output: Contact¶

Information on how to address a legal entity. A legal entity can be either a natural person or a company with an optional contact Natural Person: Must provide person Company: Must provide company

UpdateContact¶

Update a contact.

Input: UpdateContactRequest¶

Output: Contact¶

Information on how to address a legal entity. A legal entity can be either a natural person or a company with an optional contact Natural Person: Must provide person Company: Must provide company

ListContacts¶

List contacts with optional filters.

Input: ListContactsRequest¶

Output: ListContactsResponse¶

RejectOptIn¶

Explicitly reject the given opt-in.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have opt-ins as one word which
is not very readable --)
(-- api-linter: core::0136::prepositions=disabled
aip.dev/not-precedent: We need to do this because opt-in is not recognized as one word. --)

Input: OptIn¶

Output: OptInList¶

SetOptIns¶

Set the given opt-ins.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have opt-ins as one word which
is not very readable --)
(-- api-linter: core::0134::synonyms=disabled
aip.dev/not-precedent: We need to do this because we want to separate setting and rejecting of opt-ins. --)

Input: OptInList¶

Output: OptInList¶

GetOptInList¶

Get the opt-ins.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have opt-ins as one word which
is not very readable --)
(-- api-linter: core::0136::prepositions=disabled
aip.dev/not-precedent: We need to do this because opt-in is not recognized as one word. --)

Input: GetOptInListRequest¶

Output: OptInList¶

Address¶

The address of a legal entity. At least one of the following must be set.

Channel¶

Emails¶

Sends emails. Don't use this directly to communicate with customers, unless you want to force the use of email rather than letter. Use CustomerMessages for that instead.

GetEmail¶

Retrieve the status of a email send request.

Input: GetEmailRequest¶

Output: Email¶

SendEmail¶

Send an email.
(-- api-linter: core::0136::http-method=disabled
aip.dev/not-precedent: We need to do this because we want to signal an idempotent operation. --)

Input: Email¶

Output: Email¶

CustomerContactsUpdated¶

LetterAddress¶

Combines a name and a postal address.

Letters¶

Sends letters. Don't use this directly to communicate with customers, unless you want to force the use of letter rather than email. Use CustomerMessages for that instead.

GetLetter¶

Retrieve the status of a letter send request.

Input: GetLetterRequest¶

Output: Letter¶

SendLetter¶

Send a letter.
(-- api-linter: core::0136::http-method=disabled
aip.dev/not-precedent: We need to do this because we want to signal an idempotent operation. --)

Input: Letter¶

Output: Letter¶

Messages¶

Send messages to customers.

ListMessages¶

List messages with optional filters.

Input: ListMessagesRequest¶

Output: ListMessagesResponse¶

GetMessage¶

Get a specific message.

Input: GetMessageRequest¶

Output: Message¶

SendMessage¶

Send a message to a customer.
(-- api-linter: core::0136::http-method=disabled
aip.dev/not-precedent: We need to do this because we want to signal an idempotent operation. --)

Input: Message¶

Output: Message¶

FailedPreconditionMarketingDeniedError¶

The message was not sent because the marketing topic is not allowed according to the customer's preferences.

Message.Kind¶

Template¶

Shared Types¶

Amount¶

BankAccount¶

Information about a bank account.

CustomerType¶

Represents the kind of the customer.

DateRange¶

Represents a range of dates.

DateTimeRange¶

Represents a range of date times.

Decimal¶

Billing¶

Billing details.

CommunicationChannel¶

Communication channel.

Contact¶

Contact details (postal, phone, etc.).

Reading¶

Information about a reading.

Reading.ValuesEntry¶

Reading.Channel¶

Relocation¶

Information about the relocation of an contract.

Relocation.UseNewAddress¶

SalesInfo¶

Information on how a sale was made.

ScheduledRequest¶

Reference to an entity with an optional scheduled starting date.

TransitionType¶

Specifies modalities of a contract transition.

Duration¶

Represents a coarse time duration (e.g., 2 months).

EnergyDelivery¶

Describes which kind and amount of energy is to be delivered to where.

EnergyDelivery.UsageType¶

EnergyType¶

Represents the kind of the energy.

FileContent¶

AnnotationFilter¶

AnnotationFilter provides filter semantics for annotations.

DateFilter¶

DateFilter provides match semantics for date fields.

DateRangeFilter¶

DateTimeRangeFilter provides match semantics for date fields. The filter treats the start and end date as inclusive.

DateTimeFilter¶

DateTimeFilter provides match semantics for date time fields.

DateTimeRangeFilter¶

DateTimeRangeFilter provides match semantics for date time fields.

StringListFilter¶

Strings filter x IN and x NOT IN semantics.

StringScalarFilter¶

StringFilter provides match semantics for strings fields.

DateFilter.MatchMode¶

DateTimeFilter.MatchMode¶

StringScalarFilter.MatchMode¶

LetterAddress¶

Combines a name and a postal address.

MonthOfYear¶

Represents a month of a year.

PaymentMethod¶

Possible methods for paying invoices.

Period¶

A period of time with inclusive start and inclusive and exclusive end time. If both (inclusive and exclusive) ends are specified, they must be consistent. If no end is specified, the period is considered unbounded on the end. If the time is unspecified it is considered to be 00:00:00.000000000 for the start (and exclusive end) and 23:59:59.999999999 for the inclusive end.

The following example represents a period of time from 2006-01-01 to 2006-01-31: { start_time: { hours: 0 minutes: 0 seconds: 0 nanos: 0 } start_date: { year: 2006 month: 1 day: 1 } end_time: { hours: 23 minutes: 59 seconds: 59 nanos: 999999999 } end_date: { year: 2006 month: 1 day: 31 } end_date_exclusive: { year: 2006 month: 2 day: 1 } end_time_exclusive: { hours: 0 minutes: 0 seconds: 0 nanos: 0 } }

Person¶

Information on how to address a person. A person can be either a natural person or a company with an optional contact Natural Person: Must provide firstname, lastname Company: Must provide company

Person.SalutationForm¶

PostalAddress¶

Represents a postal address, e.g. for postal delivery or payments addresses.

Price¶

Represents a price before and after taxes.

Quantity¶

RecurringCost¶

Represents a price/cost that repeats at a fixed interval.

TenantScopedListRequest¶

TenantScopedResource¶

A tenant scoped resource.

TimeRange¶

A range of time with inclusive start, inclusive and exclusive end time. If both (inclusive and exclusive) ends are specified, they must be consistent. If no end is specified, the period is considered unbounded on the end.

File-level Extensions¶

CalendarPeriod¶

A CalendarPeriod represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current CalendarPeriod." All calendar times begin at midnight UTC.

Date¶

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

• A full date, with non-zero year, month, and day values
• A month and day value, with a zero year, such as an anniversary
• A year on its own, with zero month and day values
• A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Money¶

Represents an amount of money with its currency type.

Scalar Value Types¶

Legend¶