twilio/twil-content/docs/DefaultApi.md

201 lines
6.4 KiB
Markdown
Raw Normal View History

2023-07-25 00:33:20 +00:00
# \DefaultApi
All URIs are relative to *https://content.twilio.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_content**](DefaultApi.md#delete_content) | **DELETE** /v1/Content/{Sid} |
[**fetch_approval_fetch**](DefaultApi.md#fetch_approval_fetch) | **GET** /v1/Content/{Sid}/ApprovalRequests |
[**fetch_content**](DefaultApi.md#fetch_content) | **GET** /v1/Content/{Sid} |
[**list_content**](DefaultApi.md#list_content) | **GET** /v1/Content |
[**list_content_and_approvals**](DefaultApi.md#list_content_and_approvals) | **GET** /v1/ContentAndApprovals |
[**list_legacy_content**](DefaultApi.md#list_legacy_content) | **GET** /v1/LegacyContent |
## delete_content
> delete_content(sid)
Deletes a Content resource
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sid** | **String** | The Twilio-provided string that uniquely identifies the Content resource to fetch. | [required] |
### Return type
(empty response body)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## fetch_approval_fetch
> crate::models::ContentPeriodV1PeriodContentPeriodApprovalFetch fetch_approval_fetch(sid)
Fetch a Content resource's approval status by its unique Content Sid
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sid** | **String** | The Twilio-provided string that uniquely identifies the Content resource whose approval information to fetch. | [required] |
### Return type
[**crate::models::ContentPeriodV1PeriodContentPeriodApprovalFetch**](content.v1.content.approval_fetch.md)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## fetch_content
> crate::models::ContentPeriodV1PeriodContent fetch_content(sid)
Fetch a Content resource by its unique Content Sid
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**sid** | **String** | The Twilio-provided string that uniquely identifies the Content resource to fetch. | [required] |
### Return type
[**crate::models::ContentPeriodV1PeriodContent**](content.v1.content.md)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_content
> crate::models::ListContentResponse list_content(page_size, page, page_token)
Retrieve a list of Contents belonging to the account used to make the request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_size** | Option<**i32**> | How many resources to return in each list page. The default is 50, and the maximum is 1000. | |
**page** | Option<**i32**> | The page index. This value is simply for client state. | |
**page_token** | Option<**String**> | The page token. This is provided by the API. | |
### Return type
[**crate::models::ListContentResponse**](ListContentResponse.md)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_content_and_approvals
> crate::models::ListContentAndApprovalsResponse list_content_and_approvals(page_size, page, page_token)
Retrieve a list of Contents with approval statuses belonging to the account used to make the request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_size** | Option<**i32**> | How many resources to return in each list page. The default is 50, and the maximum is 1000. | |
**page** | Option<**i32**> | The page index. This value is simply for client state. | |
**page_token** | Option<**String**> | The page token. This is provided by the API. | |
### Return type
[**crate::models::ListContentAndApprovalsResponse**](ListContentAndApprovalsResponse.md)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## list_legacy_content
> crate::models::ListLegacyContentResponse list_legacy_content(page_size, page, page_token)
Retrieve a list of Legacy Contents belonging to the account used to make the request
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page_size** | Option<**i32**> | How many resources to return in each list page. The default is 50, and the maximum is 1000. | |
**page** | Option<**i32**> | The page index. This value is simply for client state. | |
**page_token** | Option<**String**> | The page token. This is provided by the API. | |
### Return type
[**crate::models::ListLegacyContentResponse**](ListLegacyContentResponse.md)
### Authorization
[accountSid_authToken](../README.md#accountSid_authToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)