@teemill/projects 1.23.1 → 1.24.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Projects API
  * Manage Teemill Projects  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.23.1
+ * The version of the OpenAPI document: 1.24.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,44 @@ export interface ApiError {
      */
     'message': string;
 }
+/**
+ *
+ * @export
+ * @interface Auth
+ */
+export interface Auth {
+    /**
+     *
+     * @type {string}
+     * @memberof Auth
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Auth
+     */
+    'projectId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Auth
+     */
+    'token'?: string;
+}
+/**
+ *
+ * @export
+ * @interface AuthResponse
+ */
+export interface AuthResponse {
+    /**
+     *
+     * @type {Array<Auth>}
+     * @memberof AuthResponse
+     */
+    'auth'?: Array<Auth>;
+}
 /**
  *
  * @export
@@ -232,6 +270,12 @@ export interface Project {
      * @memberof Project
      */
     'currency'?: ProjectCurrency | null;
+    /**
+     * The public API key for the project which can be used to access basic information about the project such as the store url
+     * @type {string}
+     * @memberof Project
+     */
+    'publicKey': string;
 }
 /**
  *
@@ -566,6 +610,14 @@ export interface UpdateProjectRequest {
  * @export
  */
 export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create an auth token for the project
+     * @summary Create auth token
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAuth: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates an invite for the project
      * @summary Creates an invite
@@ -583,6 +635,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     createProject: (createProjectRequest: CreateProjectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete an auth token for the project
+     * @summary Delete auth token
+     * @param {string} project Projects unique identifier
+     * @param {string} auth The unique id of the auth token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAuth: (project: string, auth: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Deletes an invite to the project
      * @summary Deletes an invite
@@ -609,6 +670,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists the auth tokens for the project
+     * @summary List auth tokens
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuth: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get an integration
      * @summary Get integration
@@ -649,10 +718,11 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
     /**
      * List all projects available
      * @summary List projects
+     * @param {string} [project] What project it is
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getProjects: (project?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List all templates available
      * @summary List templates
@@ -744,6 +814,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const ProjectsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create an auth token for the project
+     * @summary Create auth token
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAuth(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Auth>>;
     /**
      * Creates an invite for the project
      * @summary Creates an invite
@@ -761,6 +839,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createProject(createProjectRequest: CreateProjectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
+    /**
+     * Delete an auth token for the project
+     * @summary Delete auth token
+     * @param {string} project Projects unique identifier
+     * @param {string} auth The unique id of the auth token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAuth(project: string, auth: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Deletes an invite to the project
      * @summary Deletes an invite
@@ -787,6 +874,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Lists the auth tokens for the project
+     * @summary List auth tokens
+     * @param {string} project Projects unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuth(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthResponse>>;
     /**
      * Get an integration
      * @summary Get integration
@@ -827,10 +922,11 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
     /**
      * List all projects available
      * @summary List projects
+     * @param {string} [project] What project it is
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectsResponse>>;
+    getProjects(project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectsResponse>>;
     /**
      * List all templates available
      * @summary List templates
@@ -922,6 +1018,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create an auth token for the project
+     * @summary Create auth token
+     * @param {ProjectsApiCreateAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAuth(requestParameters: ProjectsApiCreateAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<Auth>;
     /**
      * Creates an invite for the project
      * @summary Creates an invite
@@ -938,6 +1042,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
+    /**
+     * Delete an auth token for the project
+     * @summary Delete auth token
+     * @param {ProjectsApiDeleteAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteAuth(requestParameters: ProjectsApiDeleteAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Deletes an invite to the project
      * @summary Deletes an invite
@@ -962,6 +1074,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Lists the auth tokens for the project
+     * @summary List auth tokens
+     * @param {ProjectsApiGetAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAuth(requestParameters: ProjectsApiGetAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthResponse>;
     /**
      * Get an integration
      * @summary Get integration
@@ -997,10 +1117,11 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
     /**
      * List all projects available
      * @summary List projects
+     * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProjects(options?: RawAxiosRequestConfig): AxiosPromise<ProjectsResponse>;
+    getProjects(requestParameters?: ProjectsApiGetProjectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectsResponse>;
     /**
      * List all templates available
      * @summary List templates
@@ -1074,6 +1195,19 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
      */
     updateProject(requestParameters: ProjectsApiUpdateProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
 };
+/**
+ * Request parameters for createAuth operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiCreateAuthRequest
+ */
+export interface ProjectsApiCreateAuthRequest {
+    /**
+     * Projects unique identifier
+     * @type {string}
+     * @memberof ProjectsApiCreateAuth
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for createInvite operation in ProjectsApi.
  * @export
@@ -1106,6 +1240,25 @@ export interface ProjectsApiCreateProjectRequest {
      */
     readonly createProjectRequest: CreateProjectRequest;
 }
+/**
+ * Request parameters for deleteAuth operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiDeleteAuthRequest
+ */
+export interface ProjectsApiDeleteAuthRequest {
+    /**
+     * Projects unique identifier
+     * @type {string}
+     * @memberof ProjectsApiDeleteAuth
+     */
+    readonly project: string;
+    /**
+     * The unique id of the auth token
+     * @type {string}
+     * @memberof ProjectsApiDeleteAuth
+     */
+    readonly auth: string;
+}
 /**
  * Request parameters for deleteInvite operation in ProjectsApi.
  * @export
@@ -1157,6 +1310,19 @@ export interface ProjectsApiDeleteUserRequest {
      */
     readonly user: string;
 }
+/**
+ * Request parameters for getAuth operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiGetAuthRequest
+ */
+export interface ProjectsApiGetAuthRequest {
+    /**
+     * Projects unique identifier
+     * @type {string}
+     * @memberof ProjectsApiGetAuth
+     */
+    readonly project: string;
+}
 /**
  * Request parameters for getIntegration operation in ProjectsApi.
  * @export
@@ -1239,6 +1405,19 @@ export interface ProjectsApiGetProjectRequest {
      */
     readonly project: string;
 }
+/**
+ * Request parameters for getProjects operation in ProjectsApi.
+ * @export
+ * @interface ProjectsApiGetProjectsRequest
+ */
+export interface ProjectsApiGetProjectsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProjectsApiGetProjects
+     */
+    readonly project?: string;
+}
 /**
  * Request parameters for getTemplates operation in ProjectsApi.
  * @export
@@ -1441,6 +1620,15 @@ export interface ProjectsApiUpdateProjectRequest {
  * @extends {BaseAPI}
  */
 export declare class ProjectsApi extends BaseAPI {
+    /**
+     * Create an auth token for the project
+     * @summary Create auth token
+     * @param {ProjectsApiCreateAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    createAuth(requestParameters: ProjectsApiCreateAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Auth, any>>;
     /**
      * Creates an invite for the project
      * @summary Creates an invite
@@ -1459,6 +1647,15 @@ export declare class ProjectsApi extends BaseAPI {
      * @memberof ProjectsApi
      */
     createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
+    /**
+     * Delete an auth token for the project
+     * @summary Delete auth token
+     * @param {ProjectsApiDeleteAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    deleteAuth(requestParameters: ProjectsApiDeleteAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Deletes an invite to the project
      * @summary Deletes an invite
@@ -1486,6 +1683,15 @@ export declare class ProjectsApi extends BaseAPI {
      * @memberof ProjectsApi
      */
     deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Lists the auth tokens for the project
+     * @summary List auth tokens
+     * @param {ProjectsApiGetAuthRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectsApi
+     */
+    getAuth(requestParameters: ProjectsApiGetAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthResponse, any>>;
     /**
      * Get an integration
      * @summary Get integration
@@ -1525,11 +1731,12 @@ export declare class ProjectsApi extends BaseAPI {
     /**
      * List all projects available
      * @summary List projects
+     * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProjectsApi
      */
-    getProjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectsResponse, any>>;
+    getProjects(requestParameters?: ProjectsApiGetProjectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectsResponse, any>>;
     /**
      * List all templates available
      * @summary List templates