@pollination-solutions/pollination-sdk 1.3.0 → 1.4.2

package/dist/esm/api/teams-api.d.ts

@@ -0,0 +1,544 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 1.4.2
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CreatedContent } from '../models';
+import type { Team } from '../models';
+import type { TeamCreate } from '../models';
+import type { TeamList } from '../models';
+import type { TeamMemberList } from '../models';
+import type { TeamRoleEnum } from '../models';
+import type { TeamUpdate } from '../models';
+import type { UpdateAccepted } from '../models';
+/**
+ * TeamsApi - axios parameter creator
+ * @export
+ */
+export declare const TeamsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new team (must be parent org member)
+     * @summary Create a Team
+     * @param {string} orgName
+     * @param {TeamCreate} teamCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTeam: (orgName: string, teamCreate: TeamCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Remove a member from the org (must have org `owner` role)
+     * @summary Remove a team member
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrgTeamMember: (orgName: string, teamSlug: string, username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a team (must have team or org `owner` role)
+     * @summary Delete a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTeam: (orgName: string, teamSlug: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a tean\'s members
+     * @summary List team members
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrgTeamMembers: (orgName: string, teamSlug: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a team by name
+     * @summary Get a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTeam: (orgName: string, teamSlug: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * search for orgs using query parameters
+     * @summary List Teams
+     * @param {string} orgName
+     * @param {Array<string>} [search] You know, for search
+     * @param {Array<string>} [name] The account name
+     * @param {Array<string>} [member] The ID of a user
+     * @param {number} [page] Page number starting from 1
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrgTeams: (orgName: string, search?: Array<string>, name?: Array<string>, member?: Array<string>, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a team (must have team or org `owner` role)
+     * @summary Update a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {TeamUpdate} teamUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeam: (orgName: string, teamSlug: string, teamUpdate: TeamUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upsert a member role to the team (must have org or team `owner` role)
+     * @summary Add or update the role of an Team Member
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {string} username
+     * @param {TeamRoleEnum} role
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertOrgTeamMember: (orgName: string, teamSlug: string, username: string, role: TeamRoleEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TeamsApi - functional programming interface
+ * @export
+ */
+export declare const TeamsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new team (must be parent org member)
+     * @summary Create a Team
+     * @param {string} orgName
+     * @param {TeamCreate} teamCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTeam(orgName: string, teamCreate: TeamCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatedContent>>;
+    /**
+     * Remove a member from the org (must have org `owner` role)
+     * @summary Remove a team member
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {string} username
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrgTeamMember(orgName: string, teamSlug: string, username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete a team (must have team or org `owner` role)
+     * @summary Delete a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTeam(orgName: string, teamSlug: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieve a tean\'s members
+     * @summary List team members
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrgTeamMembers(orgName: string, teamSlug: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamMemberList>>;
+    /**
+     * Retrieve a team by name
+     * @summary Get a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTeam(orgName: string, teamSlug: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Team>>;
+    /**
+     * search for orgs using query parameters
+     * @summary List Teams
+     * @param {string} orgName
+     * @param {Array<string>} [search] You know, for search
+     * @param {Array<string>} [name] The account name
+     * @param {Array<string>} [member] The ID of a user
+     * @param {number} [page] Page number starting from 1
+     * @param {number} [perPage] Number of items per page
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrgTeams(orgName: string, search?: Array<string>, name?: Array<string>, member?: Array<string>, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeamList>>;
+    /**
+     * Update a team (must have team or org `owner` role)
+     * @summary Update a Team
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {TeamUpdate} teamUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeam(orgName: string, teamSlug: string, teamUpdate: TeamUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAccepted>>;
+    /**
+     * Upsert a member role to the team (must have org or team `owner` role)
+     * @summary Add or update the role of an Team Member
+     * @param {string} orgName
+     * @param {string} teamSlug
+     * @param {string} username
+     * @param {TeamRoleEnum} role
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertOrgTeamMember(orgName: string, teamSlug: string, username: string, role: TeamRoleEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAccepted>>;
+};
+/**
+ * TeamsApi - factory interface
+ * @export
+ */
+export declare const TeamsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new team (must be parent org member)
+     * @summary Create a Team
+     * @param {TeamsApiCreateTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTeam(requestParameters: TeamsApiCreateTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatedContent>;
+    /**
+     * Remove a member from the org (must have org `owner` role)
+     * @summary Remove a team member
+     * @param {TeamsApiDeleteOrgTeamMemberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteOrgTeamMember(requestParameters: TeamsApiDeleteOrgTeamMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete a team (must have team or org `owner` role)
+     * @summary Delete a Team
+     * @param {TeamsApiDeleteTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTeam(requestParameters: TeamsApiDeleteTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieve a tean\'s members
+     * @summary List team members
+     * @param {TeamsApiGetOrgTeamMembersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrgTeamMembers(requestParameters: TeamsApiGetOrgTeamMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamMemberList>;
+    /**
+     * Retrieve a team by name
+     * @summary Get a Team
+     * @param {TeamsApiGetTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTeam(requestParameters: TeamsApiGetTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<Team>;
+    /**
+     * search for orgs using query parameters
+     * @summary List Teams
+     * @param {TeamsApiListOrgTeamsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrgTeams(requestParameters: TeamsApiListOrgTeamsRequest, options?: RawAxiosRequestConfig): AxiosPromise<TeamList>;
+    /**
+     * Update a team (must have team or org `owner` role)
+     * @summary Update a Team
+     * @param {TeamsApiUpdateTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeam(requestParameters: TeamsApiUpdateTeamRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateAccepted>;
+    /**
+     * Upsert a member role to the team (must have org or team `owner` role)
+     * @summary Add or update the role of an Team Member
+     * @param {TeamsApiUpsertOrgTeamMemberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertOrgTeamMember(requestParameters: TeamsApiUpsertOrgTeamMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateAccepted>;
+};
+/**
+ * Request parameters for createTeam operation in TeamsApi.
+ * @export
+ * @interface TeamsApiCreateTeamRequest
+ */
+export interface TeamsApiCreateTeamRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiCreateTeam
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {TeamCreate}
+     * @memberof TeamsApiCreateTeam
+     */
+    readonly teamCreate: TeamCreate;
+}
+/**
+ * Request parameters for deleteOrgTeamMember operation in TeamsApi.
+ * @export
+ * @interface TeamsApiDeleteOrgTeamMemberRequest
+ */
+export interface TeamsApiDeleteOrgTeamMemberRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiDeleteOrgTeamMember
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiDeleteOrgTeamMember
+     */
+    readonly teamSlug: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiDeleteOrgTeamMember
+     */
+    readonly username: string;
+}
+/**
+ * Request parameters for deleteTeam operation in TeamsApi.
+ * @export
+ * @interface TeamsApiDeleteTeamRequest
+ */
+export interface TeamsApiDeleteTeamRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiDeleteTeam
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiDeleteTeam
+     */
+    readonly teamSlug: string;
+}
+/**
+ * Request parameters for getOrgTeamMembers operation in TeamsApi.
+ * @export
+ * @interface TeamsApiGetOrgTeamMembersRequest
+ */
+export interface TeamsApiGetOrgTeamMembersRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiGetOrgTeamMembers
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiGetOrgTeamMembers
+     */
+    readonly teamSlug: string;
+}
+/**
+ * Request parameters for getTeam operation in TeamsApi.
+ * @export
+ * @interface TeamsApiGetTeamRequest
+ */
+export interface TeamsApiGetTeamRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiGetTeam
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiGetTeam
+     */
+    readonly teamSlug: string;
+}
+/**
+ * Request parameters for listOrgTeams operation in TeamsApi.
+ * @export
+ * @interface TeamsApiListOrgTeamsRequest
+ */
+export interface TeamsApiListOrgTeamsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly orgName: string;
+    /**
+     * You know, for search
+     * @type {Array<string>}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly search?: Array<string>;
+    /**
+     * The account name
+     * @type {Array<string>}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly name?: Array<string>;
+    /**
+     * The ID of a user
+     * @type {Array<string>}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly member?: Array<string>;
+    /**
+     * Page number starting from 1
+     * @type {number}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly page?: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof TeamsApiListOrgTeams
+     */
+    readonly perPage?: number;
+}
+/**
+ * Request parameters for updateTeam operation in TeamsApi.
+ * @export
+ * @interface TeamsApiUpdateTeamRequest
+ */
+export interface TeamsApiUpdateTeamRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiUpdateTeam
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiUpdateTeam
+     */
+    readonly teamSlug: string;
+    /**
+     *
+     * @type {TeamUpdate}
+     * @memberof TeamsApiUpdateTeam
+     */
+    readonly teamUpdate: TeamUpdate;
+}
+/**
+ * Request parameters for upsertOrgTeamMember operation in TeamsApi.
+ * @export
+ * @interface TeamsApiUpsertOrgTeamMemberRequest
+ */
+export interface TeamsApiUpsertOrgTeamMemberRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiUpsertOrgTeamMember
+     */
+    readonly orgName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiUpsertOrgTeamMember
+     */
+    readonly teamSlug: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TeamsApiUpsertOrgTeamMember
+     */
+    readonly username: string;
+    /**
+     *
+     * @type {TeamRoleEnum}
+     * @memberof TeamsApiUpsertOrgTeamMember
+     */
+    readonly role: TeamRoleEnum;
+}
+/**
+ * TeamsApi - object-oriented interface
+ * @export
+ * @class TeamsApi
+ * @extends {BaseAPI}
+ */
+export declare class TeamsApi extends BaseAPI {
+    /**
+     * Create a new team (must be parent org member)
+     * @summary Create a Team
+     * @param {TeamsApiCreateTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    createTeam(requestParameters: TeamsApiCreateTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatedContent, any>>;
+    /**
+     * Remove a member from the org (must have org `owner` role)
+     * @summary Remove a team member
+     * @param {TeamsApiDeleteOrgTeamMemberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    deleteOrgTeamMember(requestParameters: TeamsApiDeleteOrgTeamMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Delete a team (must have team or org `owner` role)
+     * @summary Delete a Team
+     * @param {TeamsApiDeleteTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    deleteTeam(requestParameters: TeamsApiDeleteTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieve a tean\'s members
+     * @summary List team members
+     * @param {TeamsApiGetOrgTeamMembersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    getOrgTeamMembers(requestParameters: TeamsApiGetOrgTeamMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamMemberList, any>>;
+    /**
+     * Retrieve a team by name
+     * @summary Get a Team
+     * @param {TeamsApiGetTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    getTeam(requestParameters: TeamsApiGetTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Team, any>>;
+    /**
+     * search for orgs using query parameters
+     * @summary List Teams
+     * @param {TeamsApiListOrgTeamsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    listOrgTeams(requestParameters: TeamsApiListOrgTeamsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeamList, any>>;
+    /**
+     * Update a team (must have team or org `owner` role)
+     * @summary Update a Team
+     * @param {TeamsApiUpdateTeamRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    updateTeam(requestParameters: TeamsApiUpdateTeamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAccepted, any>>;
+    /**
+     * Upsert a member role to the team (must have org or team `owner` role)
+     * @summary Add or update the role of an Team Member
+     * @param {TeamsApiUpsertOrgTeamMemberRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TeamsApi
+     */
+    upsertOrgTeamMember(requestParameters: TeamsApiUpsertOrgTeamMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAccepted, any>>;
+}