Struct domo_pitchfork::pitchfork::PagesRequestBuilder

pub struct PagesRequestBuilder<'t, T: 't> where
    T: DeserializeOwned,  {
    pub auth: &'t str,
    pub method: Method,
    pub url: String,
    pub resp_t: PhantomData<*const T>,
    pub body: Option<String>,
}

Request Builder for all Page API interactions

Fields

auth: &'t str

method: Method

url: String

resp_t: PhantomData<*const T>

body: Option<String>

Methods

impl<'t> PagesRequestBuilder<'t, PageInfo>

pub fn info(self, page_id: u64) -> Result<PageInfo, PitchforkError>

Info for a given Page

Example

use domo_pitchfork::pitchfork::DomoPitchfork;
let domo = DomoPitchfork::with_token("token");
let page_id = 123; // id of page to get details for.
let ds_info = domo.pages().info(page_id);
match ds_info {
    Ok(ds) => println!("{:?}",ds),
    Err(e) => println!("{}", e)
};

pub fn list(
    self,
    limit: u32,
    offset: u32
) -> Result<Vec<PageInfo>, PitchforkError>

List Pages starting from a given offset up to a given limit.

Example

use domo_pitchfork::pitchfork::DomoPitchfork;
let domo = DomoPitchfork::with_token("token");
let list = domo.pages().list(5,0)?;
list.iter().map(|p| println!("Page Name: {}", p.name));

pub fn create(self, page: &PageInfo) -> Result<PageInfo, PitchforkError>

pub fn delete(self, page_id: u64) -> Result<(), PitchforkError>

Delete the Page for the given id. This is destructive and cannot be reversed.

Example

let domo = DomoPitchfork::with_token(&token);

let page_id = 123; // id of page to delete.
// if it fails to delete, print err msg
if let Err(e) = domo.pages().delete(page_id) {
    println!("{}", e)
}

pub fn modify(
    self,
    page_id: u64,
    page: &PageInfo
) -> Result<PageInfo, PitchforkError>

pub fn collections(
    self,
    page_id: u64
) -> Result<Vec<PageCollection>, PitchforkError>

pub fn create_collection(
    self,
    page_id: u64,
    collection: &PageCollection
) -> Result<(), PitchforkError>

pub fn modify_collection(
    self,
    page_id: u64,
    collection_id: u64,
    collection: &PageCollection
) -> Result<(), PitchforkError>

pub fn delete_collection(
    self,
    page_id: u64,
    collection_id: u64
) -> Result<(), PitchforkError>

Trait Implementations

impl<'t, T> BaseRequest for PagesRequestBuilder<'t, T> where
    T: DeserializeOwned, 

fn auth(&self) -> &str

fn url(&self) -> &str

fn method(&self) -> Method

fn body(&self) -> Option<String>

impl<'t, T> DomoRequest<T> for PagesRequestBuilder<'t, T> where
    T: DeserializeOwned, 

fn run(&self) -> Result<T, PitchforkError> where
    T: DeserializeOwned, 

fn retrieve_and_deserialize_json(&self) -> Result<T, PitchforkError> where
    T: DeserializeOwned, 

fn send_csv(&self) -> Result<Response, PitchforkError>

fn send_json(&self) -> Result<Response, PitchforkError>

impl<'t, T> From<DomoRequestBuilder<'t, T>> for PagesRequestBuilder<'t, T> where
    T: DeserializeOwned, 

fn from(drb: DomoRequestBuilder<'t, T>) -> Self

Performs the conversion.