modem_comfort_exchanges

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

Overview

Name	modem_comfort_exchanges
Type	Resource
Id	ovh.xdsl.modem_comfort_exchanges

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
can_exchange	boolean	To know if you can exchange your modem (wire: canExchange)
new_model	string	Model of the new modem (wire: newModel)
price	object	Price with it's currency and textual representation
price_with_tax	object	Price with it's currency and textual representation (wire: priceWithTax)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns whether the modem of the access can be exchanged for the latest model, the new model and the price with and without tax.
create	insert	service_name		Orders the replacement of the modem of the access by the latest model. Fees apply. Returns the 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"}})
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns whether the modem of the access can be exchanged for the latest model, the new model and the price with and without tax.

SELECT
can_exchange,
new_model,
price,
price_with_tax
FROM ovh.xdsl.modem_comfort_exchanges
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Orders the replacement of the modem of the access by the latest model. Fees apply. Returns the order.

INSERT INTO ovh.xdsl.modem_comfort_exchanges (
contact_shipping,
service_name
)
SELECT 
'{{ contact_shipping }}',
'{{ service_name }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: modem_comfort_exchanges
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the modem_comfort_exchanges resource.
  - name: contact_shipping
    value: "{{ contact_shipping }}"
    description: |
      Customer identifier for shipping address. By default Internet access address will be used. Allowed values are nichandle or «/me/contact/xyz»