telephony_lines_hardware

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

Overview

Name	telephony_lines_hardware
Type	Resource
Id	ovh.order.telephony_lines_hardware

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	hardware, retractation, service_name	mondial_relay_id, shipping_contact_id	Get prices and contracts information
create	insert	service_name, hardware, retractation		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"}})
hardware	string	The hardware you want to order for this specific line
retractation	boolean	Retractation rights if set
service_name	string	Your line number (wire: serviceName)
mondial_relay_id	string	Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry. (wire: mondialRelayId)
shipping_contact_id	string	Shipping contact information id from /me entry point (wire: shippingContactId)

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_lines_hardware
WHERE hardware = '{{ hardware }}' -- required
AND retractation = '{{ retractation }}' -- required
AND service_name = '{{ service_name }}' -- required
AND mondial_relay_id = '{{ mondial_relay_id }}'
AND shipping_contact_id = '{{ shipping_contact_id }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.telephony_lines_hardware (
hardware,
mondial_relay_id,
retractation,
shipping_contact_id,
service_name
)
SELECT 
'{{ hardware }}' /* required */,
'{{ mondial_relay_id }}',
{{ retractation }} /* required */,
'{{ shipping_contact_id }}',
'{{ service_name }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: telephony_lines_hardware
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the telephony_lines_hardware resource.
  - name: hardware
    value: "{{ hardware }}"
    description: |
      The hardware you want to order for this specific line
  - name: mondial_relay_id
    value: "{{ mondial_relay_id }}"
    description: |
      Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry.
  - name: retractation
    value: {{ retractation }}
    description: |
      Retractation rights if set
  - name: shipping_contact_id
    value: "{{ shipping_contact_id }}"
    description: |
      Shipping contact information id from /me entry point