senders_documents

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

Overview

Name	senders_documents
Type	Resource
Id	ovh.sms.senders_documents

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Document name
document_id	string (uuid)	Document ID (wire: documentID)
created_at	string (date-time)	Creation datetime (wire: createdAt)
description	string	Document description
get_url	string	URL to get document (wire: getUrl)
put_url	string	URL to upload document (wire: putUrl)
size	integer	Document size (in bytes)

list

SMS senders' document

Name	Datatype	Description
name	string	Document name
document_id	string (uuid)	Document ID (wire: documentID)
created_at	string (date-time)	Creation datetime (wire: createdAt)
description	string	Document description
get_url	string	URL to get document (wire: getUrl)
put_url	string	URL to upload document (wire: putUrl)
size	integer	Document size (in bytes)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	document_id, sender, service_name		Get a validation document. Returns the validation document: name, description, size, creation date and the URL to download it.
list	select	sender, service_name	x_pagination_mode	List validation documents. Returns the identifiers of the documents sent to validate the sender. Get a validation document for its name, size and download URL.
create	insert	sender, service_name, name		Create a validation document. Creates an empty validation document with a name and a description. Returns the URL to upload the file.
update	update	document_id, sender, service_name		Update a validation document. Updates the name and the description of the validation document. The file itself is uploaded with the URL given at creation.

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"}})
document_id	string (uuid)	Document ID (wire: documentID)
sender	string	The sms sender
service_name	string	The internal name of your SMS offer (wire: serviceName)
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 validation document. Returns the validation document: name, description, size, creation date and the URL to download it.

SELECT
name,
document_id,
created_at,
description,
get_url,
put_url,
size
FROM ovh.sms.senders_documents
WHERE document_id = '{{ document_id }}' -- required
AND sender = '{{ sender }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List validation documents. Returns the identifiers of the documents sent to validate the sender. Get a validation document for its name, size and download URL.

SELECT
name,
document_id,
created_at,
description,
get_url,
put_url,
size
FROM ovh.sms.senders_documents
WHERE sender = '{{ sender }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a validation document. Creates an empty validation document with a name and a description. Returns the URL to upload the file.

INSERT INTO ovh.sms.senders_documents (
description,
name,
sender,
service_name
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ sender }}',
'{{ service_name }}'
RETURNING
name,
document_id,
created_at,
description,
get_url,
put_url,
size
;

Manifest

# Description fields are for documentation purposes
- name: senders_documents
props:
  - name: sender
    value: "{{ sender }}"
    description: Required parameter for the senders_documents resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the senders_documents resource.
  - name: description
    value: "{{ description }}"
    description: |
      Document description
  - name: name
    value: "{{ name }}"
    description: |
      Document name

UPDATE examples

update

Update a validation document. Updates the name and the description of the validation document. The file itself is uploaded with the URL given at creation.

UPDATE ovh.sms.senders_documents
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
document_id = '{{ document_id }}' --required
AND sender = '{{ sender }}' --required
AND service_name = '{{ service_name }}' --required;