freefax_convert_to_voicefaxes

Creates, updates, deletes, gets or lists a freefax_convert_to_voicefaxes resource.

Overview

Name	freefax_convert_to_voicefaxes
Type	Resource
Id	ovh.order.freefax_convert_to_voicefaxes

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, service_name		Get prices and contracts information
create	insert	service_name, billing_account		Create order

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billing_account	string	The /telephony billing account you want your service to be attached to (wire: billingAccount)
service_name	string	Freefax number (wire: serviceName)

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.freefax_convert_to_voicefaxes
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Create order

INSERT INTO ovh.order.freefax_convert_to_voicefaxes (
billing_account,
service_name
)
SELECT 
'{{ billing_account }}' /* required */,
'{{ service_name }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: freefax_convert_to_voicefaxes
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the freefax_convert_to_voicefaxes resource.
  - name: billing_account
    value: "{{ billing_account }}"
    description: |
      The /telephony billing account you want your service to be attached to