sideko_rest_api 0.9.2

Rust API Client
Documentation 
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

# org

## Module Functions

### Get Organization <a name="get"></a>

Retrieves the organization of the current authenticated user

**API Endpoint**: `GET /organization`

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client.org().get().await;
```

#### Response

##### Type

[Organization](/src/models/organization.rs)

##### Example

```rust
Organization {features: OrganizationFeatures {allow_sdk_cli: true, allow_sdk_csharp: true, allow_sdk_go: true, allow_sdk_java: true, allow_sdk_python: true, allow_sdk_rust: true, allow_sdk_tests: true, allow_sdk_typescript: true, is_free: true, max_api_projects: 123, max_doc_projects: 123, max_mock_servers: 123, max_sdk_api_methods: 123, max_service_accounts: 123, max_teammates: 123}, id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), name: "string".to_string(), subdomain: "string".to_string()}
```

### Create Organization <a name="create"></a>

**API Endpoint**: `POST /organization`

#### Parameters

| Parameter      | Required | Description | Example                         |
| -------------- | :------: | ----------- | ------------------------------- |
| `name`         |    ✓     |             | `"My Organization".to_string()` |
| `subdomain`    |    ✓     |             | `"my-org".to_string()`          |
| `sdk_language` |    ✗     |             | `SdkLanguageEnum::Csharp`       |

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .org()
    .create(sideko_rest_api::resources::org::CreateRequest {
        name: "My Organization".to_string(),
        subdomain: "my-org".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[OrganizationWithRedirect](/src/models/organization_with_redirect.rs)

##### Example

```rust
OrganizationWithRedirect {organization: Organization {features: OrganizationFeatures {allow_sdk_cli: true, allow_sdk_csharp: true, allow_sdk_go: true, allow_sdk_java: true, allow_sdk_python: true, allow_sdk_rust: true, allow_sdk_tests: true, allow_sdk_typescript: true, is_free: true, max_api_projects: 123, max_doc_projects: 123, max_mock_servers: 123, max_sdk_api_methods: 123, max_service_accounts: 123, max_teammates: 123}, id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), name: "string".to_string(), subdomain: "string".to_string()}, redirect_to: "string".to_string()}
```