Skip to content

Latest commit

 

History

History
237 lines (177 loc) · 10.6 KB

CustomerApi.md

File metadata and controls

237 lines (177 loc) · 10.6 KB
Raw

Fastly\Api\CustomerApi

$apiInstance = new Fastly\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

Methods

Method Fastly API endpoint Description
deleteCustomer() DELETE /customer/{customer_id} Delete a customer
getCustomer() GET /customer/{customer_id} Get a customer
getLoggedInCustomer() GET /current_customer Get the logged in customer
listUsers() GET /customer/{customer_id}/users List users
updateCustomer() PUT /customer/{customer_id} Update a customer

deleteCustomer()

deleteCustomer($options): \Fastly\Model\InlineResponse200 // Delete a customer

Delete a customer.

Example

    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.

try {
    $result = $apiInstance->deleteCustomer($options);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->deleteCustomer: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
customer_id string Alphanumeric string identifying the customer.

Return type

\Fastly\Model\InlineResponse200

[Back to top] [Back to API list] [Back to README]

getCustomer()

getCustomer($options): \Fastly\Model\CustomerResponse // Get a customer

Get a specific customer.

Example

    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.

try {
    $result = $apiInstance->getCustomer($options);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getCustomer: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
customer_id string Alphanumeric string identifying the customer.

Return type

\Fastly\Model\CustomerResponse

[Back to top] [Back to API list] [Back to README]

getLoggedInCustomer()

getLoggedInCustomer($options): \Fastly\Model\CustomerResponse // Get the logged in customer

Get the logged in customer.

Example

    
try {
    $result = $apiInstance->getLoggedInCustomer($options);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->getLoggedInCustomer: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

This endpoint does not need any parameters.

Return type

\Fastly\Model\CustomerResponse

[Back to top] [Back to API list] [Back to README]

listUsers()

listUsers($options): \Fastly\Model\SchemasUserResponse[] // List users

List all users from a specified customer id.

Example

    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.

try {
    $result = $apiInstance->listUsers($options);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->listUsers: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
customer_id string Alphanumeric string identifying the customer.

Return type

\Fastly\Model\SchemasUserResponse[]

[Back to top] [Back to API list] [Back to README]

updateCustomer()

updateCustomer($options): \Fastly\Model\CustomerResponse // Update a customer

Update a customer.

Example

    $options['customer_id'] = 'customer_id_example'; // string | Alphanumeric string identifying the customer.
$options['billing_contact_id'] = 'billing_contact_id_example'; // string | The alphanumeric string representing the primary billing contact.
$options['billing_network_type'] = 'billing_network_type_example'; // string | Customer's current network revenue type.
$options['billing_ref'] = 'billing_ref_example'; // string | Used for adding purchased orders to customer's account.
$options['can_configure_wordpress'] = True; // bool | Whether this customer can view or edit wordpress.
$options['can_reset_passwords'] = True; // bool | Whether this customer can reset passwords.
$options['can_upload_vcl'] = True; // bool | Whether this customer can upload VCL.
$options['force_2fa'] = True; // bool | Specifies whether 2FA is forced or not forced on the customer account. Logs out non-2FA users once 2FA is force enabled.
$options['force_sso'] = True; // bool | Specifies whether SSO is forced or not forced on the customer account.
$options['has_account_panel'] = True; // bool | Specifies whether the account has access or does not have access to the account panel.
$options['has_improved_events'] = True; // bool | Specifies whether the account has access or does not have access to the improved events.
$options['has_improved_ssl_config'] = True; // bool | Whether this customer can view or edit the SSL config.
$options['has_openstack_logging'] = True; // bool | Specifies whether the account has enabled or not enabled openstack logging.
$options['has_pci'] = True; // bool | Specifies whether the account can edit PCI for a service.
$options['has_pci_passwords'] = True; // bool | Specifies whether PCI passwords are required for the account.
$options['ip_whitelist'] = 'ip_whitelist_example'; // string | The range of IP addresses authorized to access the customer account.
$options['legal_contact_id'] = 'legal_contact_id_example'; // string | The alphanumeric string identifying the account's legal contact.
$options['name'] = 'name_example'; // string | The name of the customer, generally the company name.
$options['owner_id'] = 'owner_id_example'; // string | The alphanumeric string identifying the account owner.
$options['phone_number'] = 'phone_number_example'; // string | The phone number associated with the account.
$options['postal_address'] = 'postal_address_example'; // string | The postal address associated with the account.
$options['pricing_plan'] = 'pricing_plan_example'; // string | The pricing plan this customer is under.
$options['pricing_plan_id'] = 'pricing_plan_id_example'; // string | The alphanumeric string identifying the pricing plan.
$options['security_contact_id'] = 'security_contact_id_example'; // string | The alphanumeric string identifying the account's security contact.
$options['technical_contact_id'] = 'technical_contact_id_example'; // string | The alphanumeric string identifying the account's technical contact.

try {
    $result = $apiInstance->updateCustomer($options);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->updateCustomer: ', $e->getMessage(), PHP_EOL;
}

Options

Note: the input parameter is an associative array with the keys listed below.

Name Type Description Notes
customer_id string Alphanumeric string identifying the customer.
billing_contact_id string The alphanumeric string representing the primary billing contact. [optional]
billing_network_type string Customer's current network revenue type. [optional] [one of: 'public', 'private']
billing_ref string Used for adding purchased orders to customer's account. [optional]
can_configure_wordpress bool Whether this customer can view or edit wordpress. [optional]
can_reset_passwords bool Whether this customer can reset passwords. [optional]
can_upload_vcl bool Whether this customer can upload VCL. [optional]
force_2fa bool Specifies whether 2FA is forced or not forced on the customer account. Logs out non-2FA users once 2FA is force enabled. [optional]
force_sso bool Specifies whether SSO is forced or not forced on the customer account. [optional]
has_account_panel bool Specifies whether the account has access or does not have access to the account panel. [optional]
has_improved_events bool Specifies whether the account has access or does not have access to the improved events. [optional]
has_improved_ssl_config bool Whether this customer can view or edit the SSL config. [optional]
has_openstack_logging bool Specifies whether the account has enabled or not enabled openstack logging. [optional]
has_pci bool Specifies whether the account can edit PCI for a service. [optional]
has_pci_passwords bool Specifies whether PCI passwords are required for the account. [optional]
ip_whitelist string The range of IP addresses authorized to access the customer account. [optional]
legal_contact_id string The alphanumeric string identifying the account's legal contact. [optional]
name string The name of the customer, generally the company name. [optional]
owner_id string The alphanumeric string identifying the account owner. [optional]
phone_number string The phone number associated with the account. [optional]
postal_address string The postal address associated with the account. [optional]
pricing_plan string The pricing plan this customer is under. [optional]
pricing_plan_id string The alphanumeric string identifying the pricing plan. [optional]
security_contact_id string The alphanumeric string identifying the account's security contact. [optional]
technical_contact_id string The alphanumeric string identifying the account's technical contact. [optional]

Return type

\Fastly\Model\CustomerResponse

[Back to top] [Back to API list] [Back to README]