procedures

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

Overview

Name	procedures
Type	Resource
Id	ovh.telephony.procedures

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Procedure ID
finish_date	string (date-time)	The date at which the procedure was closed. (wire: finishDate)
pdf_url	string	The URL of the procedure document. (wire: pdfUrl)
request_date	string (date-time)	The date at which the procedure was opened. (wire: requestDate)
status	string	The current status of the procedure. (cancelled, doing, done, todo, waiting_for_customer)

list

Procedure linked to your account

Name	Datatype	Description
id	integer	Procedure ID
finish_date	string (date-time)	The date at which the procedure was closed. (wire: finishDate)
pdf_url	string	The URL of the procedure document. (wire: pdfUrl)
request_date	string (date-time)	The date at which the procedure was opened. (wire: requestDate)
status	string	The current status of the procedure. (cancelled, doing, done, todo, waiting_for_customer)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get a procedure
list	select		x_pagination_mode	List procedures (Deprecated, will be removed)
create	insert			Create a procedure (Deprecated, will be removed)
cancel	exec	id		Cancel a procedure

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"}})
id	integer	Procedure ID
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a procedure

SELECT
id,
finish_date,
pdf_url,
request_date,
status
FROM ovh.telephony.procedures
WHERE id = '{{ id }}' -- required
;

list

List procedures (Deprecated, will be removed)

SELECT
id,
finish_date,
pdf_url,
request_date,
status
FROM ovh.telephony.procedures
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a procedure (Deprecated, will be removed)

INSERT INTO ovh.telephony.procedures (
bic,
iban,
owner_address,
owner_name,
payment_mean_id
)
SELECT 
'{{ bic }}',
'{{ iban }}',
'{{ owner_address }}',
'{{ owner_name }}',
{{ payment_mean_id }}
RETURNING
id,
finish_date,
pdf_url,
request_date,
status
;

Manifest

# Description fields are for documentation purposes
- name: procedures
props:
  - name: bic
    value: "{{ bic }}"
    description: |
      Account's BIC
  - name: iban
    value: "{{ iban }}"
    description: |
      Account's IBAN
  - name: owner_address
    value: "{{ owner_address }}"
    description: |
      Account owner's address
  - name: owner_name
    value: "{{ owner_name }}"
    description: |
      Account owner's name
  - name: payment_mean_id
    value: {{ payment_mean_id }}
    description: |
      The ID of your registered SEPA account payment mean.

Lifecycle Methods

EXEC variables use wire (API) names.

cancel

Cancel a procedure

EXEC ovh.telephony.procedures.cancel 
@id='{{ id }}' --required
;