dub.api.LinksApi

Load the API package

import 'package:dub/api.dart';

All URIs are relative to https://api.dub.co

Method	HTTP request	Description
bulkCreateLinks	POST /links/bulk	Bulk create links
createLink	POST /links	Create a new link
deleteLink	DELETE /links/{linkId}	Delete a link
getLinkInfo	GET /links/info	Retrieve a link
getLinks	GET /links	Retrieve a list of links
getLinksCount	GET /links/count	Retrieve the number of links
updateLink	PATCH /links/{linkId}	Update a link
upsertLink	PUT /links/upsert	Upsert a link

bulkCreateLinks

List bulkCreateLinks(workspaceId, projectSlug, createLinkRequest)

Bulk create links

Bulk create up to 100 links for the authenticated workspace.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final List<CreateLinkRequest> createLinkRequest = ; // List<CreateLinkRequest> | 

try {
    final response = api.bulkCreateLinks(workspaceId, projectSlug, createLinkRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->bulkCreateLinks: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
createLinkRequest	List<CreateLinkRequest>		[optional]

Return type

List<LinkSchema>

Authorization

token

HTTP request headers

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

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

createLink

LinkSchema createLink(workspaceId, projectSlug, createLinkRequest)

Create a new link

Create a new link for the authenticated workspace.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final CreateLinkRequest createLinkRequest = ; // CreateLinkRequest | 

try {
    final response = api.createLink(workspaceId, projectSlug, createLinkRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->createLink: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
createLinkRequest	CreateLinkRequest		[optional]

Return type

LinkSchema

Authorization

token

HTTP request headers

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

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

deleteLink

DeleteLink200Response deleteLink(linkId, workspaceId, projectSlug)

Delete a link

Delete a link for the authenticated workspace.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String linkId = linkId_example; // String | The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.

try {
    final response = api.deleteLink(linkId, workspaceId, projectSlug);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->deleteLink: $e\n');
}

Parameters

Name	Type	Description	Notes
linkId	String	The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]

Return type

DeleteLink200Response

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getLinkInfo

LinkSchema getLinkInfo(workspaceId, projectSlug, domain, key, linkId, externalId)

Retrieve a link

Retrieve the info for a link.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final String domain = domain_example; // String | 
final String key = key_example; // String | The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`.
final String linkId = clux0rgak00011...; // String | The unique ID of the short link.
final String externalId = ext_123456; // String | This is the ID of the link in the your database. Must be prefixed with `ext_` when passed as a query parameter.

try {
    final response = api.getLinkInfo(workspaceId, projectSlug, domain, key, linkId, externalId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->getLinkInfo: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
domain	String		[optional]
key	String	The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`.	[optional]
linkId	String	The unique ID of the short link.	[optional]
externalId	String	This is the ID of the link in the your database. Must be prefixed with `ext_` when passed as a query parameter.	[optional]

Return type

LinkSchema

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getLinks

List getLinks(workspaceId, projectSlug, domain, tagId, tagIds, tagNames, search, userId, showArchived, withTags, sort, page)

Retrieve a list of links

Retrieve a list of links for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned links.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final String domain = domain_example; // String | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.
final String tagId = tagId_example; // String | The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
final GetLinksTagIdsParameter tagIds = ; // GetLinksTagIdsParameter | The tag IDs to filter the links by.
final GetLinksTagNamesParameter tagNames = ; // GetLinksTagNamesParameter | The unique name of the tags assigned to the short link (case insensitive).
final String search = search_example; // String | The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
final String userId = userId_example; // String | The user ID to filter the links by.
final bool showArchived = true; // bool | Whether to include archived links in the response. Defaults to `false` if not provided.
final bool withTags = true; // bool | Whether to include tags in the response. Defaults to `false` if not provided.
final String sort = sort_example; // String | The field to sort the links by. The default is `createdAt`, and sort order is always descending.
final num page = 8.14; // num | The page number for pagination (each page contains 100 links).

try {
    final response = api.getLinks(workspaceId, projectSlug, domain, tagId, tagIds, tagNames, search, userId, showArchived, withTags, sort, page);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->getLinks: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
domain	String	The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.	[optional]
tagId	String	The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.	[optional]
tagIds	GetLinksTagIdsParameter	The tag IDs to filter the links by.	[optional]
tagNames	GetLinksTagNamesParameter	The unique name of the tags assigned to the short link (case insensitive).	[optional]
search	String	The search term to filter the links by. The search term will be matched against the short link slug and the destination url.	[optional]
userId	String	The user ID to filter the links by.	[optional]
showArchived	bool	Whether to include archived links in the response. Defaults to `false` if not provided.	[optional] [default to false]
withTags	bool	Whether to include tags in the response. Defaults to `false` if not provided.	[optional] [default to false]
sort	String	The field to sort the links by. The default is `createdAt`, and sort order is always descending.	[optional] [default to 'createdAt']
page	num	The page number for pagination (each page contains 100 links).	[optional]

Return type

List<LinkSchema>

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getLinksCount

num getLinksCount(workspaceId, projectSlug, domain, tagId, tagIds, tagNames, search, userId, showArchived, withTags, groupBy)

Retrieve the number of links

Retrieve the number of links for the authenticated workspace. The provided query parameters allow filtering the returned links.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final String domain = domain_example; // String | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.
final String tagId = tagId_example; // String | The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
final GetLinksTagIdsParameter tagIds = ; // GetLinksTagIdsParameter | The tag IDs to filter the links by.
final GetLinksTagNamesParameter tagNames = ; // GetLinksTagNamesParameter | The unique name of the tags assigned to the short link (case insensitive).
final String search = search_example; // String | The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
final String userId = userId_example; // String | The user ID to filter the links by.
final bool showArchived = true; // bool | Whether to include archived links in the response. Defaults to `false` if not provided.
final bool withTags = true; // bool | Whether to include tags in the response. Defaults to `false` if not provided.
final GetLinksCountGroupByParameter groupBy = ; // GetLinksCountGroupByParameter | The field to group the links by.

try {
    final response = api.getLinksCount(workspaceId, projectSlug, domain, tagId, tagIds, tagNames, search, userId, showArchived, withTags, groupBy);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->getLinksCount: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
domain	String	The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.	[optional]
tagId	String	The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.	[optional]
tagIds	GetLinksTagIdsParameter	The tag IDs to filter the links by.	[optional]
tagNames	GetLinksTagNamesParameter	The unique name of the tags assigned to the short link (case insensitive).	[optional]
search	String	The search term to filter the links by. The search term will be matched against the short link slug and the destination url.	[optional]
userId	String	The user ID to filter the links by.	[optional]
showArchived	bool	Whether to include archived links in the response. Defaults to `false` if not provided.	[optional] [default to false]
withTags	bool	Whether to include tags in the response. Defaults to `false` if not provided.	[optional] [default to false]
groupBy	GetLinksCountGroupByParameter	The field to group the links by.	[optional]

Return type

num

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

updateLink

LinkSchema updateLink(linkId, workspaceId, projectSlug, createLinkRequest)

Update a link

Update a link for the authenticated workspace. If there's no change, returns it as it is.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String linkId = linkId_example; // String | The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final CreateLinkRequest createLinkRequest = ; // CreateLinkRequest | 

try {
    final response = api.updateLink(linkId, workspaceId, projectSlug, createLinkRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->updateLink: $e\n');
}

Parameters

Name	Type	Description	Notes
linkId	String	The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
createLinkRequest	CreateLinkRequest		[optional]

Return type

LinkSchema

Authorization

token

HTTP request headers

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

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

upsertLink

LinkSchema upsertLink(workspaceId, projectSlug, createLinkRequest)

Upsert a link

Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.

Example

import 'package:dub/api.dart';

final api = Dub().getLinksApi();
final String workspaceId = ws_cluuwcv0r...; // String | The ID of the workspace.
final String projectSlug = projectSlug_example; // String | The slug of the project. This field is deprecated – use `workspaceId` instead.
final CreateLinkRequest createLinkRequest = ; // CreateLinkRequest | 

try {
    final response = api.upsertLink(workspaceId, projectSlug, createLinkRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling LinksApi->upsertLink: $e\n');
}

Parameters

Name	Type	Description	Notes
workspaceId	String	The ID of the workspace.
projectSlug	String	The slug of the project. This field is deprecated – use `workspaceId` instead.	[optional]
createLinkRequest	CreateLinkRequest		[optional]

Return type

LinkSchema

Authorization

token

HTTP request headers

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

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

Files

LinksApi.md

Latest commit

History

LinksApi.md

File metadata and controls

dub.api.LinksApi

Load the API package

bulkCreateLinks

Example

Parameters

Return type

Authorization

HTTP request headers

createLink

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLink

Example

Parameters

Return type

Authorization

HTTP request headers

getLinkInfo

Example

Parameters

Return type

Authorization

HTTP request headers

getLinks

Example

Parameters

Return type

Authorization

HTTP request headers

getLinksCount

Example

Parameters

Return type

Authorization

HTTP request headers

updateLink

Example

Parameters

Return type

Authorization

HTTP request headers

upsertLink

Example

Parameters

Return type

Authorization

HTTP request headers