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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
use async_trait::async_trait;
use serde::Serialize;
use thiserror::Error;
use crate::organizations::{DomainData, Organization, OrganizationId, Organizations};
use crate::{Metadata, ResponseExt, WorkOsError, WorkOsResult};
/// The parameters for [`UpdateOrganization`].
#[derive(Debug, Serialize)]
pub struct UpdateOrganizationParams<'a> {
/// The ID of the organization.
#[serde(skip_serializing)]
pub organization_id: &'a OrganizationId,
/// A descriptive name for the Organization.
///
/// This field does not need to be unique.
pub name: Option<&'a str>,
/// The domains of the organization.
pub domain_data: Option<Vec<DomainData<'a>>>,
/// The Stripe customer ID associated with this organization.
pub stripe_customer_id: Option<&'a str>,
/// The external ID of the Organization.
pub external_id: Option<&'a str>,
/// Object containing metadata key/value pairs associated with the Organization.
pub metadata: Option<Metadata>,
}
/// An error returned from [`UpdateOrganization`].
#[derive(Debug, Error)]
pub enum UpdateOrganizationError {}
impl From<UpdateOrganizationError> for WorkOsError<UpdateOrganizationError> {
fn from(err: UpdateOrganizationError) -> Self {
Self::Operation(err)
}
}
/// [WorkOS Docs: Update an Organization](https://workos.com/docs/reference/organization/update)
#[async_trait]
pub trait UpdateOrganization {
/// Updates an organization in the current environment.
///
/// [WorkOS Docs: Update an Organization](https://workos.com/docs/reference/organization/update)
///
/// # Examples
///
/// ```
/// # use workos::WorkOsResult;
/// # use workos::organizations::*;
/// use workos::{ApiKey, Metadata, WorkOs};
///
/// # async fn run() -> WorkOsResult<(), UpdateOrganizationError> {
/// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
///
/// let organization = workos
/// .organizations()
/// .update_organization(&UpdateOrganizationParams {
/// organization_id: &OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
/// name: Some("Foo Corp"),
/// domain_data: Some(vec![DomainData {
/// domain: "foo-corp.com",
/// state: DomainDataState::Verified,
/// }]),
/// stripe_customer_id: Some("cus_R9qWAGMQ6nGE7V"),
/// external_id: Some("2fe01467-f7ea-4dd2-8b79-c2b4f56d0191"),
/// metadata: Some(Metadata::from([(
/// "tier".to_string(),
/// "diamond".to_string(),
/// )])),
/// })
/// .await?;
/// # Ok(())
/// # }
/// ```
async fn update_organization(
&self,
params: &UpdateOrganizationParams<'_>,
) -> WorkOsResult<Organization, UpdateOrganizationError>;
}
#[async_trait]
impl UpdateOrganization for Organizations<'_> {
async fn update_organization(
&self,
params: &UpdateOrganizationParams<'_>,
) -> WorkOsResult<Organization, UpdateOrganizationError> {
let url = self
.workos
.base_url()
.join(&format!("/organizations/{id}", id = params.organization_id))?;
let organization = self
.workos
.client()
.put(url)
.bearer_auth(self.workos.key())
.json(¶ms)
.send()
.await?
.handle_unauthorized_or_generic_error()
.await?
.json::<Organization>()
.await?;
Ok(organization)
}
}
#[cfg(test)]
mod test {
use serde_json::json;
use tokio;
use crate::organizations::{DomainDataState, OrganizationId};
use crate::{ApiKey, Metadata, WorkOs};
use super::*;
#[tokio::test]
async fn it_calls_the_update_organization_endpoint() {
let mut server = mockito::Server::new_async().await;
let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
.base_url(&server.url())
.unwrap()
.build();
server
.mock("PUT", "/organizations/org_01EHZNVPK3SFK441A1RGBFSHRT")
.match_header("Authorization", "Bearer sk_example_123456789")
.with_status(201)
.with_body(
json!({
"id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
"object": "organization",
"name": "Foo Corp",
"allow_profiles_outside_organization": false,
"stripe_customer_id": "cus_R9qWAGMQ6nGE7V",
"external_id": "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191",
"metadata": {
"tier": "diamond"
},
"created_at": "2021-06-25T19:07:33.155Z",
"updated_at": "2021-06-25T19:07:33.155Z",
"domains": [
{
"object": "organization_domain",
"id": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A",
"domain": "foo-corp.com",
"organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
"state": "verified",
"verification_strategy": "dns",
"verification_token": "m5Oztg3jdK4NJLgs8uIlIprMw",
"created_at": "2021-06-25T19:07:33.155Z",
"updated_at": "2021-06-25T19:07:33.155Z"
}
]
})
.to_string(),
)
.create_async()
.await;
let organization = workos
.organizations()
.update_organization(&UpdateOrganizationParams {
organization_id: &OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT"),
name: Some("Foo Corp"),
domain_data: Some(vec![DomainData {
domain: "foo-corp.com",
state: DomainDataState::Verified,
}]),
stripe_customer_id: Some("cus_R9qWAGMQ6nGE7V"),
external_id: Some("2fe01467-f7ea-4dd2-8b79-c2b4f56d0191"),
metadata: Some(Metadata::from([(
"tier".to_string(),
"diamond".to_string(),
)])),
})
.await
.unwrap();
assert_eq!(
organization.id,
OrganizationId::from("org_01EHZNVPK3SFK441A1RGBFSHRT")
)
}
}