DistributionsApi.md

core_openapi.api.DistributionsApi

Load the API package

import 'package:pieces_os_client/api.dart';

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
distributionsCreateNewDistribution	POST /distributions/create	/distributions/create [POST]
distributionsDeleteSpecificDistribution	POST /distributions/{distribution}/delete	/distributions/{distribution}/delete [POST]
distributionsSnapshot	GET /distributions	/distributions [GET]

distributionsCreateNewDistribution

Distribution distributionsCreateNewDistribution(seededDistribution)

/distributions/create [POST]

This will create a new distribution.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = DistributionsApi();
final seededDistribution = SeededDistribution(); // SeededDistribution | 

try {
    final result = api_instance.distributionsCreateNewDistribution(seededDistribution);
    print(result);
} catch (e) {
    print('Exception when calling DistributionsApi->distributionsCreateNewDistribution: $e\n');
}

Parameters

Name	Type	Description	Notes
seededDistribution	SeededDistribution		[optional]

Return type

Distribution

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

distributionsDeleteSpecificDistribution

distributionsDeleteSpecificDistribution(distribution)

/distributions/{distribution}/delete [POST]

This will delete a specific distribution.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = DistributionsApi();
final distribution = distribution_example; // String | This is the uuid of a specific distribution.

try {
    api_instance.distributionsDeleteSpecificDistribution(distribution);
} catch (e) {
    print('Exception when calling DistributionsApi->distributionsDeleteSpecificDistribution: $e\n');
}

Parameters

Name	Type	Description	Notes
distribution	String	This is the uuid of a specific distribution.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

distributionsSnapshot

Distributions distributionsSnapshot()

/distributions [GET]

This will get a specific snapshot of all our distributions.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = DistributionsApi();

try {
    final result = api_instance.distributionsSnapshot();
    print(result);
} catch (e) {
    print('Exception when calling DistributionsApi->distributionsSnapshot: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

Distributions

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]