Function CustomersApiFactory

Returns {
    createCustomer(requestParameters, options?) => AxiosPromise<Customer>;
    deleteCustomer(requestParameters, options?) => AxiosPromise<object>;
    getCustomer(requestParameters, options?) => AxiosPromise<Customer>;
    listCustomers(requestParameters, options?) => AxiosPromise<ListCustomers200Response>;
    updateCustomer(requestParameters, options?) => AxiosPromise<Customer>;
}

• createCustomer:function

  • createCustomer(requestParameters, options?): AxiosPromise<Customer>

  • Creates a Customer.

    Summary

    Create a Customer

    Throws

    Parameters

    • requestParameters: CustomersApiCreateCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Customer>

• deleteCustomer:function

  • deleteCustomer(requestParameters, options?): AxiosPromise<object>

  • Deletes a Customer. This cannot be undone.

    Summary

    Delete a Customer

    Throws

    Parameters

    • requestParameters: CustomersApiDeleteCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<object>

• getCustomer:function

  • getCustomer(requestParameters, options?): AxiosPromise<Customer>

  • Retrieves the details of an existing Customer.

    Summary

    Get a Customer

    Throws

    Parameters

    • requestParameters: CustomersApiGetCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Customer>

• listCustomers:function

  • listCustomers(requestParameters, options?): AxiosPromise<ListCustomers200Response>

  • Returns a list of Customers. The Customers are sorted with the most recently created appearing first.

    Summary

    List all Customers

    Throws

    Parameters

    • requestParameters: CustomersApiListCustomersRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListCustomers200Response>

• updateCustomer:function

  • updateCustomer(requestParameters, options?): AxiosPromise<Customer>

  • Updates a Customer by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

    Summary

    Update a Customer

    Throws

    Parameters

    • requestParameters: CustomersApiUpdateCustomerRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Customer>