Skip to main content

Invite

Invites customer to the specified reseller.

import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Customer = cloudApi.billing.customer.Customer;
const InviteCustomerRequest =
cloudApi.billing.customer_service.InviteCustomerRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.CustomerServiceClient);

const operation = await client.invite(
InviteCustomerRequest.fromPartial({
resellerId: "resellerId",
name: "name",
invitationEmail: "invitationEmail",
person: {
// name: "name",
// longname: "longname",
// phone: "phone",
// email: "email",
// postCode: "postCode",
// postAddress: "postAddress",
// legalAddress: "legalAddress",
// tin: "tin"
},
})
);
const finishedOp = await waitForOperation(operation, session);

if (finishedOp.response) {
const result = decodeMessage<typeof Customer>(finishedOp.response);
console.log(result);
}
})();

InviteCustomerRequest​

resellerId : string​

Billing account ID of the reseller that the customer will be associated with.

name : string​

Name of the customer.

invitationEmail : string​

Customer email to send invitation to.

person : CustomerPerson​

Person of the customer.

CustomerPerson​

Person of the customer. Contains legal information.

name : string​

Optional. Name of the person.

String length is not limited.

longname : string​

Optional. Long name of the person.

String length is not limited.

phone : string​

Optional. Phone of the person.

Must be a valid telephone number or a valid phoneword.

email : string​

Optional. Email of the person.

Must be a valid email address.

postCode : string​

Optional. Post code of the person.

String length is not limited.

postAddress : string​

Optional. Post address of the person.

String length is not limited.

legalAddress : string​

Optional. Legal address of the person.

String length is not limited.

tin : string​

Optional. Tax identification number of the person.

String length is not limited.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.