fireblocks_sdk::apis::smart_transfers_api

Trait SmartTransfersApi

Source 
pub trait SmartTransfersApi: Send + Sync {

Show 19 methods    // Required methods
    fn approve_dv_p_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: ApproveDvPTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<ApproveDvPTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn cancel_ticket<'life0, 'async_trait>(
        &'life0 self,
        params: CancelTicketParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<CancelTicketError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_ticket<'life0, 'async_trait>(
        &'life0 self,
        params: CreateTicketParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<CreateTicketError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: CreateTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<CreateTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn find_ticket_by_id<'life0, 'async_trait>(
        &'life0 self,
        params: FindTicketByIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FindTicketByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn find_ticket_term_by_id<'life0, 'async_trait>(
        &'life0 self,
        params: FindTicketTermByIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<FindTicketTermByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn fulfill_ticket<'life0, 'async_trait>(
        &'life0 self,
        params: FulfillTicketParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FulfillTicketError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn fund_dvp_ticket<'life0, 'async_trait>(
        &'life0 self,
        params: FundDvpTicketParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FundDvpTicketError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn fund_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: FundTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<FundTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_smart_transfer_statistic<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferStatistic, Error<GetSmartTransferStatisticError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_smart_transfer_user_groups<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferUserGroupsResponse, Error<GetSmartTransferUserGroupsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn manually_fund_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: ManuallyFundTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<ManuallyFundTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn remove_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: RemoveTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<RemoveTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn search_tickets<'life0, 'async_trait>(
        &'life0 self,
        params: SearchTicketsParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketFilteredResponse, Error<SearchTicketsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_external_ref_id<'life0, 'async_trait>(
        &'life0 self,
        params: SetExternalRefIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SetExternalRefIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_ticket_expiration<'life0, 'async_trait>(
        &'life0 self,
        params: SetTicketExpirationParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SetTicketExpirationError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_user_groups<'life0, 'async_trait>(
        &'life0 self,
        params: SetUserGroupsParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferUserGroupsResponse, Error<SetUserGroupsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn submit_ticket<'life0, 'async_trait>(
        &'life0 self,
        params: SubmitTicketParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SubmitTicketError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update_ticket_term<'life0, 'async_trait>(
        &'life0 self,
        params: UpdateTicketTermParams,
    ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<UpdateTicketTermError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

}

Required Methods§

Source

fn approve_dv_p_ticket_term<'life0, 'async_trait>( &'life0 self, params: ApproveDvPTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<ApproveDvPTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approve

Set funding source for ticket term and creating approving transaction for contract to transfer asset

Source

fn cancel_ticket<'life0, 'async_trait>( &'life0 self, params: CancelTicketParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<CancelTicketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/cancel

Cancel Smart Transfer ticket.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn create_ticket<'life0, 'async_trait>( &'life0 self, params: CreateTicketParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<CreateTicketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /smart-transfers

Creates new Smart Transfer ticket. Learn more about Fireblocks Smart Transfers in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn create_ticket_term<'life0, 'async_trait>( &'life0 self, params: CreateTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<CreateTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /smart-transfers/{ticketId}/terms

Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about Fireblocks Smart Transfers in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn find_ticket_by_id<'life0, 'async_trait>( &'life0 self, params: FindTicketByIdParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FindTicketByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /smart-transfers/{ticketId}

Find Smart Transfer ticket by id.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn find_ticket_term_by_id<'life0, 'async_trait>( &'life0 self, params: FindTicketTermByIdParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<FindTicketTermByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /smart-transfers/{ticketId}/terms/{termId}

Find a specific term of a specific Smart Transfer ticket.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn fulfill_ticket<'life0, 'async_trait>( &'life0 self, params: FulfillTicketParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FulfillTicketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/fulfill

Manually fulfill ticket, in case when all terms (legs) are funded manually.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn fund_dvp_ticket<'life0, 'async_trait>( &'life0 self, params: FundDvpTicketParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<FundDvpTicketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart_transfers/{ticketId}/dvp/fund

Create or fulfill dvp ticket order

Source

fn fund_ticket_term<'life0, 'async_trait>( &'life0 self, params: FundTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<FundTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/terms/{termId}/fund

Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer immediately).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn get_smart_transfer_statistic<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferStatistic, Error<GetSmartTransferStatisticError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /smart_transfers/statistic

Get smart transfer statistic

Source

fn get_smart_transfer_user_groups<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferUserGroupsResponse, Error<GetSmartTransferUserGroupsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /smart-transfers/settings/user-groups

Get Smart Transfer user groups.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn manually_fund_ticket_term<'life0, 'async_trait>( &'life0 self, params: ManuallyFundTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<ManuallyFundTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund

Manually set ticket term transaction.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn remove_ticket_term<'life0, 'async_trait>( &'life0 self, params: RemoveTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<(), Error<RemoveTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

DELETE /smart-transfers/{ticketId}/terms/{termId}

Delete ticket term when ticket is in DRAFT status.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn search_tickets<'life0, 'async_trait>( &'life0 self, params: SearchTicketsParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketFilteredResponse, Error<SearchTicketsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /smart-transfers

Finds Smart Transfer tickets that match the submitted criteria.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn set_external_ref_id<'life0, 'async_trait>( &'life0 self, params: SetExternalRefIdParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SetExternalRefIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/external-id

Set external id Smart Transfer ticket.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn set_ticket_expiration<'life0, 'async_trait>( &'life0 self, params: SetTicketExpirationParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SetTicketExpirationError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/expires-in

Set expiration date on Smart Transfer ticket.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn set_user_groups<'life0, 'async_trait>( &'life0 self, params: SetUserGroupsParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferUserGroupsResponse, Error<SetUserGroupsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /smart-transfers/settings/user-groups

Set Smart Transfers user group to receive email notifications for Smart Transfers.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn submit_ticket<'life0, 'async_trait>( &'life0 self, params: SubmitTicketParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketResponse, Error<SubmitTicketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/submit

Submit Smart Transfer ticket - change status into ready for approval if auto approval is not turned on, or OPEN if auto approval is on.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Source

fn update_ticket_term<'life0, 'async_trait>( &'life0 self, params: UpdateTicketTermParams, ) -> Pin<Box<dyn Future<Output = Result<SmartTransferTicketTermResponse, Error<UpdateTicketTermError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PUT /smart-transfers/{ticketId}/terms/{termId}

Update ticket term (when ticket status is DRAFT).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Implementors§