system-initiative-api-client 1.10.0 → 1.12.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/cjs/api.d.ts CHANGED
@@ -240,31 +240,31 @@ export interface AttributeArgumentBindingRequest {
240
240
  'staticValue'?: any;
241
241
  }
242
242
  /**
243
- *
243
+ * The response payload when materialized views or data is being built referenced by present or expected data.
244
244
  * @export
245
245
  * @interface BuildingResponseV1
246
246
  */
247
247
  export interface BuildingResponseV1 {
248
248
  /**
249
- *
249
+ * The estimated time for the data being built to be completed.
250
250
  * @type {number}
251
251
  * @memberof BuildingResponseV1
252
252
  */
253
253
  'estimatedCompletionSeconds': number;
254
254
  /**
255
- *
255
+ * The message reflecting the reason or state of the data being built.
256
256
  * @type {string}
257
257
  * @memberof BuildingResponseV1
258
258
  */
259
259
  'message': string;
260
260
  /**
261
- *
261
+ * The number of seconds recommended between retries for the desired data.
262
262
  * @type {number}
263
263
  * @memberof BuildingResponseV1
264
264
  */
265
265
  'retryAfterSeconds': number;
266
266
  /**
267
- *
267
+ * The status of the data being built.
268
268
  * @type {string}
269
269
  * @memberof BuildingResponseV1
270
270
  */
@@ -531,6 +531,12 @@ export interface ComponentViewV1 {
531
531
  * @memberof ComponentViewV1
532
532
  */
533
533
  'schemaVariantId': string;
534
+ /**
535
+ *
536
+ * @type {string}
537
+ * @memberof ComponentViewV1
538
+ */
539
+ 'secretId': string;
534
540
  /**
535
541
  *
536
542
  * @type {boolean}
@@ -1715,62 +1721,6 @@ export interface FuncRunViewV1 {
1715
1721
  */
1716
1722
  'updatedAt': string;
1717
1723
  }
1718
- /**
1719
- *
1720
- * @export
1721
- * @interface GenerateTemplateV1Request
1722
- */
1723
- export interface GenerateTemplateV1Request {
1724
- /**
1725
- *
1726
- * @type {string}
1727
- * @memberof GenerateTemplateV1Request
1728
- */
1729
- 'assetName': string;
1730
- /**
1731
- *
1732
- * @type {string}
1733
- * @memberof GenerateTemplateV1Request
1734
- */
1735
- 'category'?: string | null;
1736
- /**
1737
- *
1738
- * @type {Array<string>}
1739
- * @memberof GenerateTemplateV1Request
1740
- */
1741
- 'componentIds': Array<string>;
1742
- /**
1743
- *
1744
- * @type {string}
1745
- * @memberof GenerateTemplateV1Request
1746
- */
1747
- 'funcName': string;
1748
- }
1749
- /**
1750
- *
1751
- * @export
1752
- * @interface GenerateTemplateV1Response
1753
- */
1754
- export interface GenerateTemplateV1Response {
1755
- /**
1756
- *
1757
- * @type {string}
1758
- * @memberof GenerateTemplateV1Response
1759
- */
1760
- 'funcId': string;
1761
- /**
1762
- *
1763
- * @type {string}
1764
- * @memberof GenerateTemplateV1Response
1765
- */
1766
- 'schemaId': string;
1767
- /**
1768
- *
1769
- * @type {string}
1770
- * @memberof GenerateTemplateV1Response
1771
- */
1772
- 'schemaVariantId': string;
1773
- }
1774
1724
  /**
1775
1725
  *
1776
1726
  * @export
@@ -4352,16 +4302,6 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
4352
4302
  * @throws {RequiredError}
4353
4303
  */
4354
4304
  findComponent: (workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4355
- /**
4356
- *
4357
- * @summary Generate a template
4358
- * @param {string} workspaceId Workspace identifier
4359
- * @param {string} changeSetId Change Set identifier
4360
- * @param {GenerateTemplateV1Request} generateTemplateV1Request
4361
- * @param {*} [options] Override http request option.
4362
- * @throws {RequiredError}
4363
- */
4364
- generateTemplate: (workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4365
4305
  /**
4366
4306
  *
4367
4307
  * @summary Get a component by component Id
@@ -4535,16 +4475,6 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
4535
4475
  * @throws {RequiredError}
4536
4476
  */
4537
4477
  findComponent(workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
4538
- /**
4539
- *
4540
- * @summary Generate a template
4541
- * @param {string} workspaceId Workspace identifier
4542
- * @param {string} changeSetId Change Set identifier
4543
- * @param {GenerateTemplateV1Request} generateTemplateV1Request
4544
- * @param {*} [options] Override http request option.
4545
- * @throws {RequiredError}
4546
- */
4547
- generateTemplate(workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateTemplateV1Response>>;
4548
4478
  /**
4549
4479
  *
4550
4480
  * @summary Get a component by component Id
@@ -4699,14 +4629,6 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
4699
4629
  * @throws {RequiredError}
4700
4630
  */
4701
4631
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
4702
- /**
4703
- *
4704
- * @summary Generate a template
4705
- * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
4706
- * @param {*} [options] Override http request option.
4707
- * @throws {RequiredError}
4708
- */
4709
- generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
4710
4632
  /**
4711
4633
  *
4712
4634
  * @summary Get a component by component Id
@@ -4850,15 +4772,6 @@ export interface ComponentsApiInterface {
4850
4772
  * @memberof ComponentsApiInterface
4851
4773
  */
4852
4774
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
4853
- /**
4854
- *
4855
- * @summary Generate a template
4856
- * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
4857
- * @param {*} [options] Override http request option.
4858
- * @throws {RequiredError}
4859
- * @memberof ComponentsApiInterface
4860
- */
4861
- generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
4862
4775
  /**
4863
4776
  *
4864
4777
  * @summary Get a component by component Id
@@ -5150,31 +5063,6 @@ export interface ComponentsApiFindComponentRequest {
5150
5063
  */
5151
5064
  readonly componentId?: string | null;
5152
5065
  }
5153
- /**
5154
- * Request parameters for generateTemplate operation in ComponentsApi.
5155
- * @export
5156
- * @interface ComponentsApiGenerateTemplateRequest
5157
- */
5158
- export interface ComponentsApiGenerateTemplateRequest {
5159
- /**
5160
- * Workspace identifier
5161
- * @type {string}
5162
- * @memberof ComponentsApiGenerateTemplate
5163
- */
5164
- readonly workspaceId: string;
5165
- /**
5166
- * Change Set identifier
5167
- * @type {string}
5168
- * @memberof ComponentsApiGenerateTemplate
5169
- */
5170
- readonly changeSetId: string;
5171
- /**
5172
- *
5173
- * @type {GenerateTemplateV1Request}
5174
- * @memberof ComponentsApiGenerateTemplate
5175
- */
5176
- readonly generateTemplateV1Request: GenerateTemplateV1Request;
5177
- }
5178
5066
  /**
5179
5067
  * Request parameters for getComponent operation in ComponentsApi.
5180
5068
  * @export
@@ -5478,15 +5366,6 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
5478
5366
  * @memberof ComponentsApi
5479
5367
  */
5480
5368
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any, {}>>;
5481
- /**
5482
- *
5483
- * @summary Generate a template
5484
- * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
5485
- * @param {*} [options] Override http request option.
5486
- * @throws {RequiredError}
5487
- * @memberof ComponentsApi
5488
- */
5489
- generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateTemplateV1Response, any, {}>>;
5490
5369
  /**
5491
5370
  *
5492
5371
  * @summary Get a component by component Id
@@ -6313,6 +6192,16 @@ export declare class RootApi extends BaseAPI implements RootApiInterface {
6313
6192
  * @export
6314
6193
  */
6315
6194
  export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration) => {
6195
+ /**
6196
+ *
6197
+ * @summary Contribute the default variant of a schema to the module index
6198
+ * @param {string} workspaceId Workspace identifier
6199
+ * @param {string} changeSetId Change Set identifier
6200
+ * @param {string} schemaId Schema identifier
6201
+ * @param {*} [options] Override http request option.
6202
+ * @throws {RequiredError}
6203
+ */
6204
+ contribute: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6316
6205
  /**
6317
6206
  *
6318
6207
  * @summary Create a schema and it\'s default variant
@@ -6568,6 +6457,16 @@ export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration
6568
6457
  * @export
6569
6458
  */
6570
6459
  export declare const SchemasApiFp: (configuration?: Configuration) => {
6460
+ /**
6461
+ *
6462
+ * @summary Contribute the default variant of a schema to the module index
6463
+ * @param {string} workspaceId Workspace identifier
6464
+ * @param {string} changeSetId Change Set identifier
6465
+ * @param {string} schemaId Schema identifier
6466
+ * @param {*} [options] Override http request option.
6467
+ * @throws {RequiredError}
6468
+ */
6469
+ contribute(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6571
6470
  /**
6572
6471
  *
6573
6472
  * @summary Create a schema and it\'s default variant
@@ -6823,6 +6722,14 @@ export declare const SchemasApiFp: (configuration?: Configuration) => {
6823
6722
  * @export
6824
6723
  */
6825
6724
  export declare const SchemasApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6725
+ /**
6726
+ *
6727
+ * @summary Contribute the default variant of a schema to the module index
6728
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
6729
+ * @param {*} [options] Override http request option.
6730
+ * @throws {RequiredError}
6731
+ */
6732
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6826
6733
  /**
6827
6734
  *
6828
6735
  * @summary Create a schema and it\'s default variant
@@ -7006,6 +6913,15 @@ export declare const SchemasApiFactory: (configuration?: Configuration, basePath
7006
6913
  * @interface SchemasApi
7007
6914
  */
7008
6915
  export interface SchemasApiInterface {
6916
+ /**
6917
+ *
6918
+ * @summary Contribute the default variant of a schema to the module index
6919
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
6920
+ * @param {*} [options] Override http request option.
6921
+ * @throws {RequiredError}
6922
+ * @memberof SchemasApiInterface
6923
+ */
6924
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7009
6925
  /**
7010
6926
  *
7011
6927
  * @summary Create a schema and it\'s default variant
@@ -7205,6 +7121,31 @@ export interface SchemasApiInterface {
7205
7121
  */
7206
7122
  updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
7207
7123
  }
7124
+ /**
7125
+ * Request parameters for contribute operation in SchemasApi.
7126
+ * @export
7127
+ * @interface SchemasApiContributeRequest
7128
+ */
7129
+ export interface SchemasApiContributeRequest {
7130
+ /**
7131
+ * Workspace identifier
7132
+ * @type {string}
7133
+ * @memberof SchemasApiContribute
7134
+ */
7135
+ readonly workspaceId: string;
7136
+ /**
7137
+ * Change Set identifier
7138
+ * @type {string}
7139
+ * @memberof SchemasApiContribute
7140
+ */
7141
+ readonly changeSetId: string;
7142
+ /**
7143
+ * Schema identifier
7144
+ * @type {string}
7145
+ * @memberof SchemasApiContribute
7146
+ */
7147
+ readonly schemaId: string;
7148
+ }
7208
7149
  /**
7209
7150
  * Request parameters for createSchema operation in SchemasApi.
7210
7151
  * @export
@@ -7936,6 +7877,15 @@ export interface SchemasApiUpdateSchemaVariantRequest {
7936
7877
  * @extends {BaseAPI}
7937
7878
  */
7938
7879
  export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
7880
+ /**
7881
+ *
7882
+ * @summary Contribute the default variant of a schema to the module index
7883
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
7884
+ * @param {*} [options] Override http request option.
7885
+ * @throws {RequiredError}
7886
+ * @memberof SchemasApi
7887
+ */
7888
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7939
7889
  /**
7940
7890
  *
7941
7891
  * @summary Create a schema and it\'s default variant
@@ -8667,6 +8617,14 @@ export declare const WorkspaceManagementApiAxiosParamCreator: (configuration?: C
8667
8617
  * @throws {RequiredError}
8668
8618
  */
8669
8619
  inviteMember: (workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8620
+ /**
8621
+ *
8622
+ * @summary Leave a workspace (remove yourself)
8623
+ * @param {string} workspaceId Workspace identifier
8624
+ * @param {*} [options] Override http request option.
8625
+ * @throws {RequiredError}
8626
+ */
8627
+ leaveWorkspace: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8670
8628
  /**
8671
8629
  *
8672
8630
  * @summary List all members of a workspace
@@ -8748,6 +8706,14 @@ export declare const WorkspaceManagementApiFp: (configuration?: Configuration) =
8748
8706
  * @throws {RequiredError}
8749
8707
  */
8750
8708
  inviteMember(workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
8709
+ /**
8710
+ *
8711
+ * @summary Leave a workspace (remove yourself)
8712
+ * @param {string} workspaceId Workspace identifier
8713
+ * @param {*} [options] Override http request option.
8714
+ * @throws {RequiredError}
8715
+ */
8716
+ leaveWorkspace(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
8751
8717
  /**
8752
8718
  *
8753
8719
  * @summary List all members of a workspace
@@ -8828,6 +8794,14 @@ export declare const WorkspaceManagementApiFactory: (configuration?: Configurati
8828
8794
  * @throws {RequiredError}
8829
8795
  */
8830
8796
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8797
+ /**
8798
+ *
8799
+ * @summary Leave a workspace (remove yourself)
8800
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
8801
+ * @param {*} [options] Override http request option.
8802
+ * @throws {RequiredError}
8803
+ */
8804
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8831
8805
  /**
8832
8806
  *
8833
8807
  * @summary List all members of a workspace
@@ -8910,6 +8884,15 @@ export interface WorkspaceManagementApiInterface {
8910
8884
  * @memberof WorkspaceManagementApiInterface
8911
8885
  */
8912
8886
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8887
+ /**
8888
+ *
8889
+ * @summary Leave a workspace (remove yourself)
8890
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
8891
+ * @param {*} [options] Override http request option.
8892
+ * @throws {RequiredError}
8893
+ * @memberof WorkspaceManagementApiInterface
8894
+ */
8895
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8913
8896
  /**
8914
8897
  *
8915
8898
  * @summary List all members of a workspace
@@ -9013,6 +8996,19 @@ export interface WorkspaceManagementApiInviteMemberRequest {
9013
8996
  */
9014
8997
  readonly inviteMemberRequest: InviteMemberRequest;
9015
8998
  }
8999
+ /**
9000
+ * Request parameters for leaveWorkspace operation in WorkspaceManagementApi.
9001
+ * @export
9002
+ * @interface WorkspaceManagementApiLeaveWorkspaceRequest
9003
+ */
9004
+ export interface WorkspaceManagementApiLeaveWorkspaceRequest {
9005
+ /**
9006
+ * Workspace identifier
9007
+ * @type {string}
9008
+ * @memberof WorkspaceManagementApiLeaveWorkspace
9009
+ */
9010
+ readonly workspaceId: string;
9011
+ }
9016
9012
  /**
9017
9013
  * Request parameters for listMembers operation in WorkspaceManagementApi.
9018
9014
  * @export
@@ -9126,6 +9122,15 @@ export declare class WorkspaceManagementApi extends BaseAPI implements Workspace
9126
9122
  * @memberof WorkspaceManagementApi
9127
9123
  */
9128
9124
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
9125
+ /**
9126
+ *
9127
+ * @summary Leave a workspace (remove yourself)
9128
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
9129
+ * @param {*} [options] Override http request option.
9130
+ * @throws {RequiredError}
9131
+ * @memberof WorkspaceManagementApi
9132
+ */
9133
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
9129
9134
  /**
9130
9135
  *
9131
9136
  * @summary List all members of a workspace