Enterprise Apps Reseller API . customers

Instance Methods

get(customerId)

Gets a customer resource if one exists and is owned by the reseller.

insert(body, customerAuthToken=None)

Creates a customer resource if one does not already exist.

patch(customerId, body)

Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.

update(customerId, body)

Update a customer resource if one it exists and is owned by the reseller.

Method Details

get(customerId)
Gets a customer resource if one exists and is owned by the reseller.

Args:
  customerId: string, Id of the Customer (required)

Returns:
  An object of the form:

    { # JSON template for a customer.
      "customerDomain": "A String", # The domain name of the customer.
      "alternateEmail": "A String", # The alternate email of the customer.
      "kind": "reseller#customer", # Identifies the resource as a customer.
      "resourceUiUrl": "A String", # Ui url for customer resource.
      "phoneNumber": "A String", # The phone number of the customer.
      "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
        "kind": "customers#address", # Identifies the resource as a customer address.
        "organizationName": "A String", # Name of the organization.
        "countryCode": "A String", # ISO 3166 country code.
        "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # Name of the contact person.
        "addressLine1": "A String", # Address line 1 of the address.
        "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "customerId": "A String", # The id of the customer.
    }
insert(body, customerAuthToken=None)
Creates a customer resource if one does not already exist.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for a customer.
    "customerDomain": "A String", # The domain name of the customer.
    "alternateEmail": "A String", # The alternate email of the customer.
    "kind": "reseller#customer", # Identifies the resource as a customer.
    "resourceUiUrl": "A String", # Ui url for customer resource.
    "phoneNumber": "A String", # The phone number of the customer.
    "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
      "kind": "customers#address", # Identifies the resource as a customer address.
      "organizationName": "A String", # Name of the organization.
      "countryCode": "A String", # ISO 3166 country code.
      "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # Name of the contact person.
      "addressLine1": "A String", # Address line 1 of the address.
      "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "customerId": "A String", # The id of the customer.
  }

  customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.

Returns:
  An object of the form:

    { # JSON template for a customer.
      "customerDomain": "A String", # The domain name of the customer.
      "alternateEmail": "A String", # The alternate email of the customer.
      "kind": "reseller#customer", # Identifies the resource as a customer.
      "resourceUiUrl": "A String", # Ui url for customer resource.
      "phoneNumber": "A String", # The phone number of the customer.
      "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
        "kind": "customers#address", # Identifies the resource as a customer address.
        "organizationName": "A String", # Name of the organization.
        "countryCode": "A String", # ISO 3166 country code.
        "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # Name of the contact person.
        "addressLine1": "A String", # Address line 1 of the address.
        "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "customerId": "A String", # The id of the customer.
    }
patch(customerId, body)
Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.

Args:
  customerId: string, Id of the Customer (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for a customer.
    "customerDomain": "A String", # The domain name of the customer.
    "alternateEmail": "A String", # The alternate email of the customer.
    "kind": "reseller#customer", # Identifies the resource as a customer.
    "resourceUiUrl": "A String", # Ui url for customer resource.
    "phoneNumber": "A String", # The phone number of the customer.
    "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
      "kind": "customers#address", # Identifies the resource as a customer address.
      "organizationName": "A String", # Name of the organization.
      "countryCode": "A String", # ISO 3166 country code.
      "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # Name of the contact person.
      "addressLine1": "A String", # Address line 1 of the address.
      "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "customerId": "A String", # The id of the customer.
  }


Returns:
  An object of the form:

    { # JSON template for a customer.
      "customerDomain": "A String", # The domain name of the customer.
      "alternateEmail": "A String", # The alternate email of the customer.
      "kind": "reseller#customer", # Identifies the resource as a customer.
      "resourceUiUrl": "A String", # Ui url for customer resource.
      "phoneNumber": "A String", # The phone number of the customer.
      "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
        "kind": "customers#address", # Identifies the resource as a customer address.
        "organizationName": "A String", # Name of the organization.
        "countryCode": "A String", # ISO 3166 country code.
        "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # Name of the contact person.
        "addressLine1": "A String", # Address line 1 of the address.
        "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "customerId": "A String", # The id of the customer.
    }
update(customerId, body)
Update a customer resource if one it exists and is owned by the reseller.

Args:
  customerId: string, Id of the Customer (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for a customer.
    "customerDomain": "A String", # The domain name of the customer.
    "alternateEmail": "A String", # The alternate email of the customer.
    "kind": "reseller#customer", # Identifies the resource as a customer.
    "resourceUiUrl": "A String", # Ui url for customer resource.
    "phoneNumber": "A String", # The phone number of the customer.
    "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
      "kind": "customers#address", # Identifies the resource as a customer address.
      "organizationName": "A String", # Name of the organization.
      "countryCode": "A String", # ISO 3166 country code.
      "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      "addressLine2": "A String", # Address line 2 of the address.
      "addressLine3": "A String", # Address line 3 of the address.
      "contactName": "A String", # Name of the contact person.
      "addressLine1": "A String", # Address line 1 of the address.
      "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
    },
    "customerId": "A String", # The id of the customer.
  }


Returns:
  An object of the form:

    { # JSON template for a customer.
      "customerDomain": "A String", # The domain name of the customer.
      "alternateEmail": "A String", # The alternate email of the customer.
      "kind": "reseller#customer", # Identifies the resource as a customer.
      "resourceUiUrl": "A String", # Ui url for customer resource.
      "phoneNumber": "A String", # The phone number of the customer.
      "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
        "kind": "customers#address", # Identifies the resource as a customer address.
        "organizationName": "A String", # Name of the organization.
        "countryCode": "A String", # ISO 3166 country code.
        "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
        "addressLine2": "A String", # Address line 2 of the address.
        "addressLine3": "A String", # Address line 3 of the address.
        "contactName": "A String", # Name of the contact person.
        "addressLine1": "A String", # Address line 1 of the address.
        "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
      },
      "customerId": "A String", # The id of the customer.
    }