1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::AccountId;
use crate::params::{Expand, Object, Timestamp};
/// The resource representing a Stripe "AccountLink".
///
/// For more details see <https://stripe.com/docs/api/account_links/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct AccountLink {
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// The timestamp at which this account link will expire.
pub expires_at: Timestamp,
/// The URL for the account link.
pub url: String,
}
impl AccountLink {
/// Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
pub fn create(client: &Client, params: CreateAccountLink<'_>) -> Response<AccountLink> {
client.post_form("/account_links", ¶ms)
}
}
impl Object for AccountLink {
type Id = ();
fn id(&self) -> Self::Id {}
fn object(&self) -> &'static str {
"account_link"
}
}
/// The parameters for `AccountLink::create`.
#[derive(Clone, Debug, Serialize)]
pub struct CreateAccountLink<'a> {
/// The identifier of the account to create an account link for.
pub account: AccountId,
/// Which information the platform needs to collect from the user.
///
/// One of `currently_due` or `eventually_due`.
/// Default is `currently_due`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collect: Option<AccountLinkCollect>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid.
///
/// The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding.
/// If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub refresh_url: Option<&'a str>,
/// The URL that the user will be redirected to upon leaving or completing the linked flow.
#[serde(skip_serializing_if = "Option::is_none")]
pub return_url: Option<&'a str>,
/// The type of account link the user is requesting.
///
/// Possible values are `account_onboarding` or `account_update`.
#[serde(rename = "type")]
pub type_: AccountLinkType,
}
impl<'a> CreateAccountLink<'a> {
pub fn new(account: AccountId, type_: AccountLinkType) -> Self {
CreateAccountLink {
account,
collect: Default::default(),
expand: Default::default(),
refresh_url: Default::default(),
return_url: Default::default(),
type_,
}
}
}
/// An enum representing the possible values of an `CreateAccountLink`'s `collect` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum AccountLinkCollect {
CurrentlyDue,
EventuallyDue,
}
impl AccountLinkCollect {
pub fn as_str(self) -> &'static str {
match self {
AccountLinkCollect::CurrentlyDue => "currently_due",
AccountLinkCollect::EventuallyDue => "eventually_due",
}
}
}
impl AsRef<str> for AccountLinkCollect {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for AccountLinkCollect {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for AccountLinkCollect {
fn default() -> Self {
Self::CurrentlyDue
}
}
/// An enum representing the possible values of an `CreateAccountLink`'s `type_` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum AccountLinkType {
AccountOnboarding,
AccountUpdate,
CustomAccountUpdate,
CustomAccountVerification,
}
impl AccountLinkType {
pub fn as_str(self) -> &'static str {
match self {
AccountLinkType::AccountOnboarding => "account_onboarding",
AccountLinkType::AccountUpdate => "account_update",
AccountLinkType::CustomAccountUpdate => "custom_account_update",
AccountLinkType::CustomAccountVerification => "custom_account_verification",
}
}
}
impl AsRef<str> for AccountLinkType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for AccountLinkType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for AccountLinkType {
fn default() -> Self {
Self::AccountOnboarding
}
}