Struct mailchimp_api::file_manager::FileManager

source ·

pub struct FileManager {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl FileManager

source

pub async fn get_file(
 &self,
 fields: &[String],
 exclude_fields: &[String],
 count: i64,
 offset: i64,
 type_: &str,
 created_by: &str,
 before_created_at: &str,
 since_created_at: &str,
 sort_field: GetFileManagerFilesSortField,
 sort_dir: SortDir
) -> Result<FileManager>

List stored files.

This function performs a GET to the /file-manager/files endpoint.

Get a list of available images and files stored in the File Manager for the account.

Parameters:

fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
type_: &str – The file type for the File Manager file.
created_by: &str – The Mailchimp account user who created the File Manager file.
before_created_at: &str – Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_created_at: &str – Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sort_field: crate::types::GetFileManagerFilesSortField – Returns files sorted by the specified field.
sort_dir: crate::types::SortDir – Determines the order direction for sorted results.

source

pub async fn post(&self, body: &GalleryFile) -> Result<Files>

Add file.

This function performs a POST to the /file-manager/files endpoint.

Upload a new image or file to the File Manager.

source

pub async fn get_file_file_manager(
 &self,
 fields: &[String],
 exclude_fields: &[String],
 file_id: &str
) -> Result<Files>

Get file.

This function performs a GET to the /file-manager/files/{file_id} endpoint.

Get information about a specific file in the File Manager.

Parameters:

fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
file_id: &str – The unique id for the File Manager file.

source

pub async fn delete_files(&self, file_id: &str) -> Result<()>

Delete file.

This function performs a DELETE to the /file-manager/files/{file_id} endpoint.

Remove a specific file from the File Manager.

Parameters:

file_id: &str – The unique id for the File Manager file.

source

pub async fn patch_files(
 &self,
 file_id: &str,
 body: &GalleryFileData
) -> Result<Files>

Update file.

This function performs a PATCH to the /file-manager/files/{file_id} endpoint.

Update a file in the File Manager.

Parameters:

file_id: &str – The unique id for the File Manager file.

source

pub async fn get_folder(
 &self,
 fields: &[String],
 exclude_fields: &[String],
 count: i64,
 offset: i64,
 created_by: &str,
 before_created_at: &str,
 since_created_at: &str
) -> Result<FileManagerFolders>

List folders.

This function performs a GET to the /file-manager/folders endpoint.

Get a list of all folders in the File Manager.

Parameters:

fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
created_by: &str – The Mailchimp account user who created the File Manager file.
before_created_at: &str – Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_created_at: &str – Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

source

pub async fn post_folder(
&self,
body: &GalleryFolder
) -> Result<FileManagerFoldersGalleryFolder>

Add folder.

This function performs a POST to the /file-manager/folders endpoint.

Create a new folder in the File Manager.

source

pub async fn get_folder_file_manager(
 &self,
 fields: &[String],
 exclude_fields: &[String],
 folder_id: &str
) -> Result<FileManagerFoldersGalleryFolder>

Get folder.

This function performs a GET to the /file-manager/folders/{folder_id} endpoint.

Get information about a specific folder in the File Manager.

Parameters:

fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
folder_id: &str – The unique id for the File Manager folder.

source

pub async fn delete_folders(&self, folder_id: &str) -> Result<()>

Delete folder.

This function performs a DELETE to the /file-manager/folders/{folder_id} endpoint.

Delete a specific folder in the File Manager.

Parameters:

folder_id: &str – The unique id for the File Manager folder.

source

pub async fn patch_folders(
 &self,
 folder_id: &str,
 body: &GalleryFolder
) -> Result<FileManagerFoldersGalleryFolder>

Update folder.

This function performs a PATCH to the /file-manager/folders/{folder_id} endpoint.

Update a specific File Manager folder.

Parameters:

folder_id: &str – The unique id for the File Manager folder.

Auto Trait Implementations

impl !RefUnwindSafe for FileManager

impl Send for FileManager

impl Sync for FileManager

impl Unpin for FileManager

impl !UnwindSafe for FileManager

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct mailchimp_api::file_manager::FileManager

Fields

Implementations

impl FileManager

pub async fn get_file( &self, fields: &[String], exclude_fields: &[String], count: i64, offset: i64, type_: &str, created_by: &str, before_created_at: &str, since_created_at: &str, sort_field: GetFileManagerFilesSortField, sort_dir: SortDir) -> Result<FileManager>

pub async fn post(&self, body: &GalleryFile) -> Result<Files>

pub async fn get_file_file_manager( &self, fields: &[String], exclude_fields: &[String], file_id: &str) -> Result<Files>

pub async fn delete_files(&self, file_id: &str) -> Result<()>

pub async fn patch_files( &self, file_id: &str, body: &GalleryFileData) -> Result<Files>

pub async fn get_folder( &self, fields: &[String], exclude_fields: &[String], count: i64, offset: i64, created_by: &str, before_created_at: &str, since_created_at: &str) -> Result<FileManagerFolders>

pub async fn post_folder( &self, body: &GalleryFolder) -> Result<FileManagerFoldersGalleryFolder>

pub async fn get_folder_file_manager( &self, fields: &[String], exclude_fields: &[String], folder_id: &str) -> Result<FileManagerFoldersGalleryFolder>

pub async fn delete_folders(&self, folder_id: &str) -> Result<()>

pub async fn patch_folders( &self, folder_id: &str, body: &GalleryFolder) -> Result<FileManagerFoldersGalleryFolder>

Auto Trait Implementations

impl !RefUnwindSafe for FileManager

impl Send for FileManager

impl Sync for FileManager

impl Unpin for FileManager

impl !UnwindSafe for FileManager

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn get_file(
&self,
fields: &[String],
exclude_fields: &[String],
count: i64,
offset: i64,
type_: &str,
created_by: &str,
before_created_at: &str,
since_created_at: &str,
sort_field: GetFileManagerFilesSortField,
sort_dir: SortDir
) -> Result<FileManager>

pub async fn get_file_file_manager(
&self,
fields: &[String],
exclude_fields: &[String],
file_id: &str
) -> Result<Files>

pub async fn patch_files(
&self,
file_id: &str,
body: &GalleryFileData
) -> Result<Files>

pub async fn get_folder(
&self,
fields: &[String],
exclude_fields: &[String],
count: i64,
offset: i64,
created_by: &str,
before_created_at: &str,
since_created_at: &str
) -> Result<FileManagerFolders>

pub async fn post_folder(
&self,
body: &GalleryFolder
) -> Result<FileManagerFoldersGalleryFolder>

pub async fn get_folder_file_manager(
&self,
fields: &[String],
exclude_fields: &[String],
folder_id: &str
) -> Result<FileManagerFoldersGalleryFolder>

pub async fn patch_folders(
&self,
folder_id: &str,
body: &GalleryFolder
) -> Result<FileManagerFoldersGalleryFolder>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,