Skip to content

feat: Update TypeScript client #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Update TypeScript client #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 194 additions & 0 deletions src/apis/BitlinksApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ import type {
SortedLinks,
TemporarilyUnavailable,
TimeUnit,
TotalEngagements,
TotalEngagementsSummary,
UnprocessableEntity,
UpgradeRequired,
} from '../models/index';
Expand Down Expand Up @@ -103,6 +105,10 @@ import {
TemporarilyUnavailableToJSON,
TimeUnitFromJSON,
TimeUnitToJSON,
TotalEngagementsFromJSON,
TotalEngagementsToJSON,
TotalEngagementsSummaryFromJSON,
TotalEngagementsSummaryToJSON,
UnprocessableEntityFromJSON,
UnprocessableEntityToJSON,
UpgradeRequiredFromJSON,
Expand Down Expand Up @@ -144,6 +150,8 @@ export interface GetBitlinksByGroupRequest {
channel_guid?: string;
custom_bitlink?: GetBitlinksByGroupCustomBitlinkEnum;
has_qr_codes?: GetBitlinksByGroupHasQrCodesEnum;
is_expired?: GetBitlinksByGroupIsExpiredEnum;
has_expiration?: GetBitlinksByGroupHasExpirationEnum;
tags?: Array<string>;
launchpad_ids?: Array<string>;
encoding_login?: Array<string>;
Expand All @@ -163,6 +171,20 @@ export interface GetClicksSummaryForBitlinkRequest {
unit_reference?: string;
}

export interface GetEngagementsRequest {
bitlink: string;
unit: TimeUnit;
units: number;
unit_reference?: string;
}

export interface GetEngagementsSummaryRequest {
bitlink: string;
unit: TimeUnit;
units: number;
unit_reference?: string;
}

export interface GetMetricsForBitlinkByCitiesRequest {
bitlink: string;
unit: TimeUnit;
Expand Down Expand Up @@ -550,6 +572,14 @@ export class BitlinksApi extends runtime.BaseAPI {
queryParameters['has_qr_codes'] = requestParameters['has_qr_codes'];
}

if (requestParameters['is_expired'] != null) {
queryParameters['is_expired'] = requestParameters['is_expired'];
}

if (requestParameters['has_expiration'] != null) {
queryParameters['has_expiration'] = requestParameters['has_expiration'];
}

if (requestParameters['tags'] != null) {
queryParameters['tags'] = requestParameters['tags'];
}
Expand Down Expand Up @@ -741,6 +771,152 @@ export class BitlinksApi extends runtime.BaseAPI {
return await response.value();
}

/**
* Returns an array of engagement counts for the specified link. The array is comprised of button click, click and scan counts for each time window, where the window is based on the provided unit.
* Get Engagement Counts for a Bitlink
*/
async getEngagementsRaw(requestParameters: GetEngagementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TotalEngagements>> {
if (requestParameters['bitlink'] == null) {
throw new runtime.RequiredError(
'bitlink',
'Required parameter "bitlink" was null or undefined when calling getEngagements().'
);
}

if (requestParameters['unit'] == null) {
throw new runtime.RequiredError(
'unit',
'Required parameter "unit" was null or undefined when calling getEngagements().'
);
}

if (requestParameters['units'] == null) {
throw new runtime.RequiredError(
'units',
'Required parameter "units" was null or undefined when calling getEngagements().'
);
}

const queryParameters: any = {};

if (requestParameters['unit'] != null) {
queryParameters['unit'] = requestParameters['unit'];
}

if (requestParameters['units'] != null) {
queryParameters['units'] = requestParameters['units'];
}

if (requestParameters['unit_reference'] != null) {
queryParameters['unit_reference'] = requestParameters['unit_reference'];
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearerAuth", []);

if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}

let urlPath = `/bitlinks/{bitlink}/engagements`;
urlPath = urlPath.replace(`{${"bitlink"}}`, encodeURIComponent(String(requestParameters['bitlink'])));

const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);

return new runtime.JSONApiResponse(response, (jsonValue) => TotalEngagementsFromJSON(jsonValue));
}

/**
* Returns an array of engagement counts for the specified link. The array is comprised of button click, click and scan counts for each time window, where the window is based on the provided unit.
* Get Engagement Counts for a Bitlink
*/
async getEngagements(requestParameters: GetEngagementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotalEngagements> {
const response = await this.getEngagementsRaw(requestParameters, initOverrides);
return await response.value();
}

/**
* Returns the engagement counts for the specified link rolled up into a single field.
* Get an Engagement Count Summary for a Bitlink
*/
async getEngagementsSummaryRaw(requestParameters: GetEngagementsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TotalEngagementsSummary>> {
if (requestParameters['bitlink'] == null) {
throw new runtime.RequiredError(
'bitlink',
'Required parameter "bitlink" was null or undefined when calling getEngagementsSummary().'
);
}

if (requestParameters['unit'] == null) {
throw new runtime.RequiredError(
'unit',
'Required parameter "unit" was null or undefined when calling getEngagementsSummary().'
);
}

if (requestParameters['units'] == null) {
throw new runtime.RequiredError(
'units',
'Required parameter "units" was null or undefined when calling getEngagementsSummary().'
);
}

const queryParameters: any = {};

if (requestParameters['unit'] != null) {
queryParameters['unit'] = requestParameters['unit'];
}

if (requestParameters['units'] != null) {
queryParameters['units'] = requestParameters['units'];
}

if (requestParameters['unit_reference'] != null) {
queryParameters['unit_reference'] = requestParameters['unit_reference'];
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
const token = this.configuration.accessToken;
const tokenString = await token("bearerAuth", []);

if (tokenString) {
headerParameters["Authorization"] = `Bearer ${tokenString}`;
}
}

let urlPath = `/bitlinks/{bitlink}/engagements/summary`;
urlPath = urlPath.replace(`{${"bitlink"}}`, encodeURIComponent(String(requestParameters['bitlink'])));

const response = await this.request({
path: urlPath,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);

return new runtime.JSONApiResponse(response, (jsonValue) => TotalEngagementsSummaryFromJSON(jsonValue));
}

/**
* Returns the engagement counts for the specified link rolled up into a single field.
* Get an Engagement Count Summary for a Bitlink
*/
async getEngagementsSummary(requestParameters: GetEngagementsSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotalEngagementsSummary> {
const response = await this.getEngagementsSummaryRaw(requestParameters, initOverrides);
return await response.value();
}

/**
* Returns the city origins of click traffic for the specified link.
* Get Metrics for a Bitlink by City
Expand Down Expand Up @@ -1512,6 +1688,24 @@ export enum GetBitlinksByGroupHasQrCodesEnum {
off = 'off',
both = 'both'
}
/**
* @export
* @enum {string}
*/
export enum GetBitlinksByGroupIsExpiredEnum {
on = 'on',
off = 'off',
both = 'both'
}
/**
* @export
* @enum {string}
*/
export enum GetBitlinksByGroupHasExpirationEnum {
on = 'on',
off = 'off',
both = 'both'
}
/**
* @export
* @enum {string}
Expand Down
14 changes: 14 additions & 0 deletions src/apis/GroupsApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ export interface GetGroupShortenCountsRequest {

export interface GetGroupTagsRequest {
group_guid: string;
type?: GetGroupTagsTypeEnum;
}

export interface GetGroupTopCodeScansRequest {
Expand Down Expand Up @@ -1705,6 +1706,10 @@ export class GroupsApi extends runtime.BaseAPI {

const queryParameters: any = {};

if (requestParameters['type'] != null) {
queryParameters['type'] = requestParameters['type'];
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
Expand Down Expand Up @@ -2123,3 +2128,12 @@ export class GroupsApi extends runtime.BaseAPI {
}

}

/**
* @export
* @enum {string}
*/
export enum GetGroupTagsTypeEnum {
bitlink = 'bitlink',
qr_code = 'qr_code'
}
18 changes: 13 additions & 5 deletions src/apis/OrganizationsApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ export interface GetOrganizationShortenCountsByGroupRequest {
organization_guid: string;
}

export interface GetOrganizationsRequest {
include_all?: boolean;
}

export interface GetPlanLimitsRequest {
organization_guid: string;
}
Expand Down Expand Up @@ -238,12 +242,16 @@ export class OrganizationsApi extends runtime.BaseAPI {
}

/**
* Retrieve a list of organizations.
* Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token\'s allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured.
* Retrieve Organizations
*/
async getOrganizationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organizations>> {
async getOrganizationsRaw(requestParameters: GetOrganizationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Organizations>> {
const queryParameters: any = {};

if (requestParameters['include_all'] != null) {
queryParameters['include_all'] = requestParameters['include_all'];
}

const headerParameters: runtime.HTTPHeaders = {};

if (this.configuration && this.configuration.accessToken) {
Expand All @@ -268,11 +276,11 @@ export class OrganizationsApi extends runtime.BaseAPI {
}

/**
* Retrieve a list of organizations.
* Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token\'s allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured.
* Retrieve Organizations
*/
async getOrganizations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organizations> {
const response = await this.getOrganizationsRaw(initOverrides);
async getOrganizations(requestParameters: GetOrganizationsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Organizations> {
const response = await this.getOrganizationsRaw(requestParameters, initOverrides);
return await response.value();
}

Expand Down
Loading