feat: add partner create endpoint (#21625)

This commit is contained in:
Jason Rasmussen 2025-09-05 17:59:11 -04:00 committed by GitHub
parent db0ea0f3a8
commit 5a7042364b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 477 additions and 75 deletions

View file

@ -22,14 +22,14 @@ class PartnerApiRepository extends ApiRepository {
}
Future<UserDto> create(String id) async {
final dto = await checkNull(_api.createPartner(id));
final dto = await checkNull(_api.createPartnerDeprecated(id));
return UserConverter.fromPartnerDto(dto);
}
Future<void> delete(String id) => _api.removePartner(id);
Future<UserDto> update(String id, {required bool inTimeline}) async {
final dto = await checkNull(_api.updatePartner(id, UpdatePartnerDto(inTimeline: inTimeline)));
final dto = await checkNull(_api.updatePartner(id, PartnerUpdateDto(inTimeline: inTimeline)));
return UserConverter.fromPartnerDto(dto);
}
}

View file

@ -126,6 +126,7 @@ Class | Method | HTTP request | Description
*AuthenticationApi* | [**signUpAdmin**](doc//AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up |
*AuthenticationApi* | [**unlockAuthSession**](doc//AuthenticationApi.md#unlockauthsession) | **POST** /auth/session/unlock |
*AuthenticationApi* | [**validateAccessToken**](doc//AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken |
*DeprecatedApi* | [**createPartnerDeprecated**](doc//DeprecatedApi.md#createpartnerdeprecated) | **POST** /partners/{id} |
*DeprecatedApi* | [**getRandom**](doc//DeprecatedApi.md#getrandom) | **GET** /assets/random |
*DownloadApi* | [**downloadArchive**](doc//DownloadApi.md#downloadarchive) | **POST** /download/archive |
*DownloadApi* | [**getDownloadInfo**](doc//DownloadApi.md#getdownloadinfo) | **POST** /download/info |
@ -171,7 +172,8 @@ Class | Method | HTTP request | Description
*OAuthApi* | [**redirectOAuthToMobile**](doc//OAuthApi.md#redirectoauthtomobile) | **GET** /oauth/mobile-redirect |
*OAuthApi* | [**startOAuth**](doc//OAuthApi.md#startoauth) | **POST** /oauth/authorize |
*OAuthApi* | [**unlinkOAuthAccount**](doc//OAuthApi.md#unlinkoauthaccount) | **POST** /oauth/unlink |
*PartnersApi* | [**createPartner**](doc//PartnersApi.md#createpartner) | **POST** /partners/{id} |
*PartnersApi* | [**createPartner**](doc//PartnersApi.md#createpartner) | **POST** /partners |
*PartnersApi* | [**createPartnerDeprecated**](doc//PartnersApi.md#createpartnerdeprecated) | **POST** /partners/{id} |
*PartnersApi* | [**getPartners**](doc//PartnersApi.md#getpartners) | **GET** /partners |
*PartnersApi* | [**removePartner**](doc//PartnersApi.md#removepartner) | **DELETE** /partners/{id} |
*PartnersApi* | [**updatePartner**](doc//PartnersApi.md#updatepartner) | **PUT** /partners/{id} |
@ -416,8 +418,10 @@ Class | Method | HTTP request | Description
- [OnThisDayDto](doc//OnThisDayDto.md)
- [OnboardingDto](doc//OnboardingDto.md)
- [OnboardingResponseDto](doc//OnboardingResponseDto.md)
- [PartnerCreateDto](doc//PartnerCreateDto.md)
- [PartnerDirection](doc//PartnerDirection.md)
- [PartnerResponseDto](doc//PartnerResponseDto.md)
- [PartnerUpdateDto](doc//PartnerUpdateDto.md)
- [PeopleResponse](doc//PeopleResponse.md)
- [PeopleResponseDto](doc//PeopleResponseDto.md)
- [PeopleUpdate](doc//PeopleUpdate.md)
@ -566,7 +570,6 @@ Class | Method | HTTP request | Description
- [UpdateAlbumUserDto](doc//UpdateAlbumUserDto.md)
- [UpdateAssetDto](doc//UpdateAssetDto.md)
- [UpdateLibraryDto](doc//UpdateLibraryDto.md)
- [UpdatePartnerDto](doc//UpdatePartnerDto.md)
- [UsageByUserDto](doc//UsageByUserDto.md)
- [UserAdminCreateDto](doc//UserAdminCreateDto.md)
- [UserAdminDeleteDto](doc//UserAdminDeleteDto.md)

View file

@ -190,8 +190,10 @@ part 'model/o_auth_token_endpoint_auth_method.dart';
part 'model/on_this_day_dto.dart';
part 'model/onboarding_dto.dart';
part 'model/onboarding_response_dto.dart';
part 'model/partner_create_dto.dart';
part 'model/partner_direction.dart';
part 'model/partner_response_dto.dart';
part 'model/partner_update_dto.dart';
part 'model/people_response.dart';
part 'model/people_response_dto.dart';
part 'model/people_update.dart';
@ -340,7 +342,6 @@ part 'model/update_album_dto.dart';
part 'model/update_album_user_dto.dart';
part 'model/update_asset_dto.dart';
part 'model/update_library_dto.dart';
part 'model/update_partner_dto.dart';
part 'model/usage_by_user_dto.dart';
part 'model/user_admin_create_dto.dart';
part 'model/user_admin_delete_dto.dart';

View file

@ -16,6 +16,59 @@ class DeprecatedApi {
final ApiClient apiClient;
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> createPartnerDeprecatedWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>[];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
Future<PartnerResponseDto?> createPartnerDeprecated(String id,) async {
final response = await createPartnerDeprecatedWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PartnerResponseDto',) as PartnerResponseDto;
}
return null;
}
/// This property was deprecated in v1.116.0. This endpoint requires the `asset.read` permission.
///
/// Note: This method returns the HTTP [Response].

View file

@ -22,8 +22,60 @@ class PartnersApi {
///
/// Parameters:
///
/// * [PartnerCreateDto] partnerCreateDto (required):
Future<Response> createPartnerWithHttpInfo(PartnerCreateDto partnerCreateDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners';
// ignore: prefer_final_locals
Object? postBody = partnerCreateDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
apiPath,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [PartnerCreateDto] partnerCreateDto (required):
Future<PartnerResponseDto?> createPartner(PartnerCreateDto partnerCreateDto,) async {
final response = await createPartnerWithHttpInfo(partnerCreateDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'PartnerResponseDto',) as PartnerResponseDto;
}
return null;
}
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Note: This method returns the HTTP [Response].
///
/// Parameters:
///
/// * [String] id (required):
Future<Response> createPartnerWithHttpInfo(String id,) async {
Future<Response> createPartnerDeprecatedWithHttpInfo(String id,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
@ -49,13 +101,13 @@ class PartnersApi {
);
}
/// This endpoint requires the `partner.create` permission.
/// This property was deprecated in v1.141.0. This endpoint requires the `partner.create` permission.
///
/// Parameters:
///
/// * [String] id (required):
Future<PartnerResponseDto?> createPartner(String id,) async {
final response = await createPartnerWithHttpInfo(id,);
Future<PartnerResponseDto?> createPartnerDeprecated(String id,) async {
final response = await createPartnerDeprecatedWithHttpInfo(id,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@ -179,14 +231,14 @@ class PartnersApi {
///
/// * [String] id (required):
///
/// * [UpdatePartnerDto] updatePartnerDto (required):
Future<Response> updatePartnerWithHttpInfo(String id, UpdatePartnerDto updatePartnerDto,) async {
/// * [PartnerUpdateDto] partnerUpdateDto (required):
Future<Response> updatePartnerWithHttpInfo(String id, PartnerUpdateDto partnerUpdateDto,) async {
// ignore: prefer_const_declarations
final apiPath = r'/partners/{id}'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody = updatePartnerDto;
Object? postBody = partnerUpdateDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
@ -212,9 +264,9 @@ class PartnersApi {
///
/// * [String] id (required):
///
/// * [UpdatePartnerDto] updatePartnerDto (required):
Future<PartnerResponseDto?> updatePartner(String id, UpdatePartnerDto updatePartnerDto,) async {
final response = await updatePartnerWithHttpInfo(id, updatePartnerDto,);
/// * [PartnerUpdateDto] partnerUpdateDto (required):
Future<PartnerResponseDto?> updatePartner(String id, PartnerUpdateDto partnerUpdateDto,) async {
final response = await updatePartnerWithHttpInfo(id, partnerUpdateDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}

View file

@ -434,10 +434,14 @@ class ApiClient {
return OnboardingDto.fromJson(value);
case 'OnboardingResponseDto':
return OnboardingResponseDto.fromJson(value);
case 'PartnerCreateDto':
return PartnerCreateDto.fromJson(value);
case 'PartnerDirection':
return PartnerDirectionTypeTransformer().decode(value);
case 'PartnerResponseDto':
return PartnerResponseDto.fromJson(value);
case 'PartnerUpdateDto':
return PartnerUpdateDto.fromJson(value);
case 'PeopleResponse':
return PeopleResponse.fromJson(value);
case 'PeopleResponseDto':
@ -734,8 +738,6 @@ class ApiClient {
return UpdateAssetDto.fromJson(value);
case 'UpdateLibraryDto':
return UpdateLibraryDto.fromJson(value);
case 'UpdatePartnerDto':
return UpdatePartnerDto.fromJson(value);
case 'UsageByUserDto':
return UsageByUserDto.fromJson(value);
case 'UserAdminCreateDto':

View file

@ -0,0 +1,99 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.18
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class PartnerCreateDto {
/// Returns a new [PartnerCreateDto] instance.
PartnerCreateDto({
required this.sharedWithId,
});
String sharedWithId;
@override
bool operator ==(Object other) => identical(this, other) || other is PartnerCreateDto &&
other.sharedWithId == sharedWithId;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(sharedWithId.hashCode);
@override
String toString() => 'PartnerCreateDto[sharedWithId=$sharedWithId]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'sharedWithId'] = this.sharedWithId;
return json;
}
/// Returns a new [PartnerCreateDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static PartnerCreateDto? fromJson(dynamic value) {
upgradeDto(value, "PartnerCreateDto");
if (value is Map) {
final json = value.cast<String, dynamic>();
return PartnerCreateDto(
sharedWithId: mapValueOfType<String>(json, r'sharedWithId')!,
);
}
return null;
}
static List<PartnerCreateDto> listFromJson(dynamic json, {bool growable = false,}) {
final result = <PartnerCreateDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = PartnerCreateDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, PartnerCreateDto> mapFromJson(dynamic json) {
final map = <String, PartnerCreateDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = PartnerCreateDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of PartnerCreateDto-objects as value to a dart map
static Map<String, List<PartnerCreateDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<PartnerCreateDto>>{};
if (json is Map && json.isNotEmpty) {
// ignore: parameter_assignments
json = json.cast<String, dynamic>();
for (final entry in json.entries) {
map[entry.key] = PartnerCreateDto.listFromJson(entry.value, growable: growable,);
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'sharedWithId',
};
}

View file

@ -10,16 +10,16 @@
part of openapi.api;
class UpdatePartnerDto {
/// Returns a new [UpdatePartnerDto] instance.
UpdatePartnerDto({
class PartnerUpdateDto {
/// Returns a new [PartnerUpdateDto] instance.
PartnerUpdateDto({
required this.inTimeline,
});
bool inTimeline;
@override
bool operator ==(Object other) => identical(this, other) || other is UpdatePartnerDto &&
bool operator ==(Object other) => identical(this, other) || other is PartnerUpdateDto &&
other.inTimeline == inTimeline;
@override
@ -28,7 +28,7 @@ class UpdatePartnerDto {
(inTimeline.hashCode);
@override
String toString() => 'UpdatePartnerDto[inTimeline=$inTimeline]';
String toString() => 'PartnerUpdateDto[inTimeline=$inTimeline]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
@ -36,26 +36,26 @@ class UpdatePartnerDto {
return json;
}
/// Returns a new [UpdatePartnerDto] instance and imports its values from
/// Returns a new [PartnerUpdateDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static UpdatePartnerDto? fromJson(dynamic value) {
upgradeDto(value, "UpdatePartnerDto");
static PartnerUpdateDto? fromJson(dynamic value) {
upgradeDto(value, "PartnerUpdateDto");
if (value is Map) {
final json = value.cast<String, dynamic>();
return UpdatePartnerDto(
return PartnerUpdateDto(
inTimeline: mapValueOfType<bool>(json, r'inTimeline')!,
);
}
return null;
}
static List<UpdatePartnerDto> listFromJson(dynamic json, {bool growable = false,}) {
final result = <UpdatePartnerDto>[];
static List<PartnerUpdateDto> listFromJson(dynamic json, {bool growable = false,}) {
final result = <PartnerUpdateDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = UpdatePartnerDto.fromJson(row);
final value = PartnerUpdateDto.fromJson(row);
if (value != null) {
result.add(value);
}
@ -64,12 +64,12 @@ class UpdatePartnerDto {
return result.toList(growable: growable);
}
static Map<String, UpdatePartnerDto> mapFromJson(dynamic json) {
final map = <String, UpdatePartnerDto>{};
static Map<String, PartnerUpdateDto> mapFromJson(dynamic json) {
final map = <String, PartnerUpdateDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = UpdatePartnerDto.fromJson(entry.value);
final value = PartnerUpdateDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
@ -78,14 +78,14 @@ class UpdatePartnerDto {
return map;
}
// maps a json object with a list of UpdatePartnerDto-objects as value to a dart map
static Map<String, List<UpdatePartnerDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<UpdatePartnerDto>>{};
// maps a json object with a list of PartnerUpdateDto-objects as value to a dart map
static Map<String, List<PartnerUpdateDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<PartnerUpdateDto>>{};
if (json is Map && json.isNotEmpty) {
// ignore: parameter_assignments
json = json.cast<String, dynamic>();
for (final entry in json.entries) {
map[entry.key] = UpdatePartnerDto.listFromJson(entry.value, growable: growable,);
map[entry.key] = PartnerUpdateDto.listFromJson(entry.value, growable: growable,);
}
}
return map;