@teemill/projects 1.23.1 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Projects API
3
3
  * Manage Teemill Projects For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
4
  *
5
- * The version of the OpenAPI document: 1.23.1
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,6 +32,44 @@ export interface ApiError {
32
32
  */
33
33
  'message': string;
34
34
  }
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface Auth
39
+ */
40
+ export interface Auth {
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof Auth
45
+ */
46
+ 'id'?: string;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof Auth
51
+ */
52
+ 'projectId'?: string;
53
+ /**
54
+ *
55
+ * @type {string}
56
+ * @memberof Auth
57
+ */
58
+ 'token'?: string;
59
+ }
60
+ /**
61
+ *
62
+ * @export
63
+ * @interface AuthResponse
64
+ */
65
+ export interface AuthResponse {
66
+ /**
67
+ *
68
+ * @type {Array<Auth>}
69
+ * @memberof AuthResponse
70
+ */
71
+ 'auth'?: Array<Auth>;
72
+ }
35
73
  /**
36
74
  *
37
75
  * @export
@@ -232,6 +270,12 @@ export interface Project {
232
270
  * @memberof Project
233
271
  */
234
272
  'currency'?: ProjectCurrency | null;
273
+ /**
274
+ * The public API key for the project which can be used to access basic information about the project such as the store url
275
+ * @type {string}
276
+ * @memberof Project
277
+ */
278
+ 'publicKey': string;
235
279
  }
236
280
  /**
237
281
  *
@@ -566,6 +610,14 @@ export interface UpdateProjectRequest {
566
610
  * @export
567
611
  */
568
612
  export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
613
+ /**
614
+ * Create an auth token for the project
615
+ * @summary Create auth token
616
+ * @param {string} project Projects unique identifier
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ */
620
+ createAuth: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
569
621
  /**
570
622
  * Creates an invite for the project
571
623
  * @summary Creates an invite
@@ -583,6 +635,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
583
635
  * @throws {RequiredError}
584
636
  */
585
637
  createProject: (createProjectRequest: CreateProjectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
638
+ /**
639
+ * Delete an auth token for the project
640
+ * @summary Delete auth token
641
+ * @param {string} project Projects unique identifier
642
+ * @param {string} auth The unique id of the auth token
643
+ * @param {*} [options] Override http request option.
644
+ * @throws {RequiredError}
645
+ */
646
+ deleteAuth: (project: string, auth: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
586
647
  /**
587
648
  * Deletes an invite to the project
588
649
  * @summary Deletes an invite
@@ -609,6 +670,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
609
670
  * @throws {RequiredError}
610
671
  */
611
672
  deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
673
+ /**
674
+ * Lists the auth tokens for the project
675
+ * @summary List auth tokens
676
+ * @param {string} project Projects unique identifier
677
+ * @param {*} [options] Override http request option.
678
+ * @throws {RequiredError}
679
+ */
680
+ getAuth: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
612
681
  /**
613
682
  * Get an integration
614
683
  * @summary Get integration
@@ -649,10 +718,11 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
649
718
  /**
650
719
  * List all projects available
651
720
  * @summary List projects
721
+ * @param {string} [project] What project it is
652
722
  * @param {*} [options] Override http request option.
653
723
  * @throws {RequiredError}
654
724
  */
655
- getProjects: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
725
+ getProjects: (project?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
656
726
  /**
657
727
  * List all templates available
658
728
  * @summary List templates
@@ -744,6 +814,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
744
814
  * @export
745
815
  */
746
816
  export declare const ProjectsApiFp: (configuration?: Configuration) => {
817
+ /**
818
+ * Create an auth token for the project
819
+ * @summary Create auth token
820
+ * @param {string} project Projects unique identifier
821
+ * @param {*} [options] Override http request option.
822
+ * @throws {RequiredError}
823
+ */
824
+ createAuth(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Auth>>;
747
825
  /**
748
826
  * Creates an invite for the project
749
827
  * @summary Creates an invite
@@ -761,6 +839,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
761
839
  * @throws {RequiredError}
762
840
  */
763
841
  createProject(createProjectRequest: CreateProjectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Project>>;
842
+ /**
843
+ * Delete an auth token for the project
844
+ * @summary Delete auth token
845
+ * @param {string} project Projects unique identifier
846
+ * @param {string} auth The unique id of the auth token
847
+ * @param {*} [options] Override http request option.
848
+ * @throws {RequiredError}
849
+ */
850
+ deleteAuth(project: string, auth: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
764
851
  /**
765
852
  * Deletes an invite to the project
766
853
  * @summary Deletes an invite
@@ -787,6 +874,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
787
874
  * @throws {RequiredError}
788
875
  */
789
876
  deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
877
+ /**
878
+ * Lists the auth tokens for the project
879
+ * @summary List auth tokens
880
+ * @param {string} project Projects unique identifier
881
+ * @param {*} [options] Override http request option.
882
+ * @throws {RequiredError}
883
+ */
884
+ getAuth(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthResponse>>;
790
885
  /**
791
886
  * Get an integration
792
887
  * @summary Get integration
@@ -827,10 +922,11 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
827
922
  /**
828
923
  * List all projects available
829
924
  * @summary List projects
925
+ * @param {string} [project] What project it is
830
926
  * @param {*} [options] Override http request option.
831
927
  * @throws {RequiredError}
832
928
  */
833
- getProjects(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectsResponse>>;
929
+ getProjects(project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectsResponse>>;
834
930
  /**
835
931
  * List all templates available
836
932
  * @summary List templates
@@ -922,6 +1018,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
922
1018
  * @export
923
1019
  */
924
1020
  export declare const ProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1021
+ /**
1022
+ * Create an auth token for the project
1023
+ * @summary Create auth token
1024
+ * @param {ProjectsApiCreateAuthRequest} requestParameters Request parameters.
1025
+ * @param {*} [options] Override http request option.
1026
+ * @throws {RequiredError}
1027
+ */
1028
+ createAuth(requestParameters: ProjectsApiCreateAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<Auth>;
925
1029
  /**
926
1030
  * Creates an invite for the project
927
1031
  * @summary Creates an invite
@@ -938,6 +1042,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
938
1042
  * @throws {RequiredError}
939
1043
  */
940
1044
  createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
1045
+ /**
1046
+ * Delete an auth token for the project
1047
+ * @summary Delete auth token
1048
+ * @param {ProjectsApiDeleteAuthRequest} requestParameters Request parameters.
1049
+ * @param {*} [options] Override http request option.
1050
+ * @throws {RequiredError}
1051
+ */
1052
+ deleteAuth(requestParameters: ProjectsApiDeleteAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
941
1053
  /**
942
1054
  * Deletes an invite to the project
943
1055
  * @summary Deletes an invite
@@ -962,6 +1074,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
962
1074
  * @throws {RequiredError}
963
1075
  */
964
1076
  deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1077
+ /**
1078
+ * Lists the auth tokens for the project
1079
+ * @summary List auth tokens
1080
+ * @param {ProjectsApiGetAuthRequest} requestParameters Request parameters.
1081
+ * @param {*} [options] Override http request option.
1082
+ * @throws {RequiredError}
1083
+ */
1084
+ getAuth(requestParameters: ProjectsApiGetAuthRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthResponse>;
965
1085
  /**
966
1086
  * Get an integration
967
1087
  * @summary Get integration
@@ -997,10 +1117,11 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
997
1117
  /**
998
1118
  * List all projects available
999
1119
  * @summary List projects
1120
+ * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
1000
1121
  * @param {*} [options] Override http request option.
1001
1122
  * @throws {RequiredError}
1002
1123
  */
1003
- getProjects(options?: RawAxiosRequestConfig): AxiosPromise<ProjectsResponse>;
1124
+ getProjects(requestParameters?: ProjectsApiGetProjectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectsResponse>;
1004
1125
  /**
1005
1126
  * List all templates available
1006
1127
  * @summary List templates
@@ -1074,6 +1195,19 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
1074
1195
  */
1075
1196
  updateProject(requestParameters: ProjectsApiUpdateProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<Project>;
1076
1197
  };
1198
+ /**
1199
+ * Request parameters for createAuth operation in ProjectsApi.
1200
+ * @export
1201
+ * @interface ProjectsApiCreateAuthRequest
1202
+ */
1203
+ export interface ProjectsApiCreateAuthRequest {
1204
+ /**
1205
+ * Projects unique identifier
1206
+ * @type {string}
1207
+ * @memberof ProjectsApiCreateAuth
1208
+ */
1209
+ readonly project: string;
1210
+ }
1077
1211
  /**
1078
1212
  * Request parameters for createInvite operation in ProjectsApi.
1079
1213
  * @export
@@ -1106,6 +1240,25 @@ export interface ProjectsApiCreateProjectRequest {
1106
1240
  */
1107
1241
  readonly createProjectRequest: CreateProjectRequest;
1108
1242
  }
1243
+ /**
1244
+ * Request parameters for deleteAuth operation in ProjectsApi.
1245
+ * @export
1246
+ * @interface ProjectsApiDeleteAuthRequest
1247
+ */
1248
+ export interface ProjectsApiDeleteAuthRequest {
1249
+ /**
1250
+ * Projects unique identifier
1251
+ * @type {string}
1252
+ * @memberof ProjectsApiDeleteAuth
1253
+ */
1254
+ readonly project: string;
1255
+ /**
1256
+ * The unique id of the auth token
1257
+ * @type {string}
1258
+ * @memberof ProjectsApiDeleteAuth
1259
+ */
1260
+ readonly auth: string;
1261
+ }
1109
1262
  /**
1110
1263
  * Request parameters for deleteInvite operation in ProjectsApi.
1111
1264
  * @export
@@ -1157,6 +1310,19 @@ export interface ProjectsApiDeleteUserRequest {
1157
1310
  */
1158
1311
  readonly user: string;
1159
1312
  }
1313
+ /**
1314
+ * Request parameters for getAuth operation in ProjectsApi.
1315
+ * @export
1316
+ * @interface ProjectsApiGetAuthRequest
1317
+ */
1318
+ export interface ProjectsApiGetAuthRequest {
1319
+ /**
1320
+ * Projects unique identifier
1321
+ * @type {string}
1322
+ * @memberof ProjectsApiGetAuth
1323
+ */
1324
+ readonly project: string;
1325
+ }
1160
1326
  /**
1161
1327
  * Request parameters for getIntegration operation in ProjectsApi.
1162
1328
  * @export
@@ -1239,6 +1405,19 @@ export interface ProjectsApiGetProjectRequest {
1239
1405
  */
1240
1406
  readonly project: string;
1241
1407
  }
1408
+ /**
1409
+ * Request parameters for getProjects operation in ProjectsApi.
1410
+ * @export
1411
+ * @interface ProjectsApiGetProjectsRequest
1412
+ */
1413
+ export interface ProjectsApiGetProjectsRequest {
1414
+ /**
1415
+ * What project it is
1416
+ * @type {string}
1417
+ * @memberof ProjectsApiGetProjects
1418
+ */
1419
+ readonly project?: string;
1420
+ }
1242
1421
  /**
1243
1422
  * Request parameters for getTemplates operation in ProjectsApi.
1244
1423
  * @export
@@ -1441,6 +1620,15 @@ export interface ProjectsApiUpdateProjectRequest {
1441
1620
  * @extends {BaseAPI}
1442
1621
  */
1443
1622
  export declare class ProjectsApi extends BaseAPI {
1623
+ /**
1624
+ * Create an auth token for the project
1625
+ * @summary Create auth token
1626
+ * @param {ProjectsApiCreateAuthRequest} requestParameters Request parameters.
1627
+ * @param {*} [options] Override http request option.
1628
+ * @throws {RequiredError}
1629
+ * @memberof ProjectsApi
1630
+ */
1631
+ createAuth(requestParameters: ProjectsApiCreateAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Auth, any>>;
1444
1632
  /**
1445
1633
  * Creates an invite for the project
1446
1634
  * @summary Creates an invite
@@ -1459,6 +1647,15 @@ export declare class ProjectsApi extends BaseAPI {
1459
1647
  * @memberof ProjectsApi
1460
1648
  */
1461
1649
  createProject(requestParameters: ProjectsApiCreateProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Project, any>>;
1650
+ /**
1651
+ * Delete an auth token for the project
1652
+ * @summary Delete auth token
1653
+ * @param {ProjectsApiDeleteAuthRequest} requestParameters Request parameters.
1654
+ * @param {*} [options] Override http request option.
1655
+ * @throws {RequiredError}
1656
+ * @memberof ProjectsApi
1657
+ */
1658
+ deleteAuth(requestParameters: ProjectsApiDeleteAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1462
1659
  /**
1463
1660
  * Deletes an invite to the project
1464
1661
  * @summary Deletes an invite
@@ -1486,6 +1683,15 @@ export declare class ProjectsApi extends BaseAPI {
1486
1683
  * @memberof ProjectsApi
1487
1684
  */
1488
1685
  deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1686
+ /**
1687
+ * Lists the auth tokens for the project
1688
+ * @summary List auth tokens
1689
+ * @param {ProjectsApiGetAuthRequest} requestParameters Request parameters.
1690
+ * @param {*} [options] Override http request option.
1691
+ * @throws {RequiredError}
1692
+ * @memberof ProjectsApi
1693
+ */
1694
+ getAuth(requestParameters: ProjectsApiGetAuthRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthResponse, any>>;
1489
1695
  /**
1490
1696
  * Get an integration
1491
1697
  * @summary Get integration
@@ -1525,11 +1731,12 @@ export declare class ProjectsApi extends BaseAPI {
1525
1731
  /**
1526
1732
  * List all projects available
1527
1733
  * @summary List projects
1734
+ * @param {ProjectsApiGetProjectsRequest} requestParameters Request parameters.
1528
1735
  * @param {*} [options] Override http request option.
1529
1736
  * @throws {RequiredError}
1530
1737
  * @memberof ProjectsApi
1531
1738
  */
1532
- getProjects(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectsResponse, any>>;
1739
+ getProjects(requestParameters?: ProjectsApiGetProjectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectsResponse, any>>;
1533
1740
  /**
1534
1741
  * List all templates available
1535
1742
  * @summary List templates