system-initiative-api-client 1.10.0 → 1.11.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
  */
@@ -1715,62 +1715,6 @@ export interface FuncRunViewV1 {
1715
1715
  */
1716
1716
  'updatedAt': string;
1717
1717
  }
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
1718
  /**
1775
1719
  *
1776
1720
  * @export
@@ -4352,16 +4296,6 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
4352
4296
  * @throws {RequiredError}
4353
4297
  */
4354
4298
  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
4299
  /**
4366
4300
  *
4367
4301
  * @summary Get a component by component Id
@@ -4535,16 +4469,6 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
4535
4469
  * @throws {RequiredError}
4536
4470
  */
4537
4471
  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
4472
  /**
4549
4473
  *
4550
4474
  * @summary Get a component by component Id
@@ -4699,14 +4623,6 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
4699
4623
  * @throws {RequiredError}
4700
4624
  */
4701
4625
  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
4626
  /**
4711
4627
  *
4712
4628
  * @summary Get a component by component Id
@@ -4850,15 +4766,6 @@ export interface ComponentsApiInterface {
4850
4766
  * @memberof ComponentsApiInterface
4851
4767
  */
4852
4768
  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
4769
  /**
4863
4770
  *
4864
4771
  * @summary Get a component by component Id
@@ -5150,31 +5057,6 @@ export interface ComponentsApiFindComponentRequest {
5150
5057
  */
5151
5058
  readonly componentId?: string | null;
5152
5059
  }
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
5060
  /**
5179
5061
  * Request parameters for getComponent operation in ComponentsApi.
5180
5062
  * @export
@@ -5478,15 +5360,6 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
5478
5360
  * @memberof ComponentsApi
5479
5361
  */
5480
5362
  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
5363
  /**
5491
5364
  *
5492
5365
  * @summary Get a component by component Id
@@ -6313,6 +6186,16 @@ export declare class RootApi extends BaseAPI implements RootApiInterface {
6313
6186
  * @export
6314
6187
  */
6315
6188
  export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration) => {
6189
+ /**
6190
+ *
6191
+ * @summary Contribute the default variant of a schema to the module index
6192
+ * @param {string} workspaceId Workspace identifier
6193
+ * @param {string} changeSetId Change Set identifier
6194
+ * @param {string} schemaId Schema identifier
6195
+ * @param {*} [options] Override http request option.
6196
+ * @throws {RequiredError}
6197
+ */
6198
+ contribute: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6316
6199
  /**
6317
6200
  *
6318
6201
  * @summary Create a schema and it\'s default variant
@@ -6568,6 +6451,16 @@ export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration
6568
6451
  * @export
6569
6452
  */
6570
6453
  export declare const SchemasApiFp: (configuration?: Configuration) => {
6454
+ /**
6455
+ *
6456
+ * @summary Contribute the default variant of a schema to the module index
6457
+ * @param {string} workspaceId Workspace identifier
6458
+ * @param {string} changeSetId Change Set identifier
6459
+ * @param {string} schemaId Schema identifier
6460
+ * @param {*} [options] Override http request option.
6461
+ * @throws {RequiredError}
6462
+ */
6463
+ contribute(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6571
6464
  /**
6572
6465
  *
6573
6466
  * @summary Create a schema and it\'s default variant
@@ -6823,6 +6716,14 @@ export declare const SchemasApiFp: (configuration?: Configuration) => {
6823
6716
  * @export
6824
6717
  */
6825
6718
  export declare const SchemasApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6719
+ /**
6720
+ *
6721
+ * @summary Contribute the default variant of a schema to the module index
6722
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
6723
+ * @param {*} [options] Override http request option.
6724
+ * @throws {RequiredError}
6725
+ */
6726
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6826
6727
  /**
6827
6728
  *
6828
6729
  * @summary Create a schema and it\'s default variant
@@ -7006,6 +6907,15 @@ export declare const SchemasApiFactory: (configuration?: Configuration, basePath
7006
6907
  * @interface SchemasApi
7007
6908
  */
7008
6909
  export interface SchemasApiInterface {
6910
+ /**
6911
+ *
6912
+ * @summary Contribute the default variant of a schema to the module index
6913
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
6914
+ * @param {*} [options] Override http request option.
6915
+ * @throws {RequiredError}
6916
+ * @memberof SchemasApiInterface
6917
+ */
6918
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7009
6919
  /**
7010
6920
  *
7011
6921
  * @summary Create a schema and it\'s default variant
@@ -7205,6 +7115,31 @@ export interface SchemasApiInterface {
7205
7115
  */
7206
7116
  updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
7207
7117
  }
7118
+ /**
7119
+ * Request parameters for contribute operation in SchemasApi.
7120
+ * @export
7121
+ * @interface SchemasApiContributeRequest
7122
+ */
7123
+ export interface SchemasApiContributeRequest {
7124
+ /**
7125
+ * Workspace identifier
7126
+ * @type {string}
7127
+ * @memberof SchemasApiContribute
7128
+ */
7129
+ readonly workspaceId: string;
7130
+ /**
7131
+ * Change Set identifier
7132
+ * @type {string}
7133
+ * @memberof SchemasApiContribute
7134
+ */
7135
+ readonly changeSetId: string;
7136
+ /**
7137
+ * Schema identifier
7138
+ * @type {string}
7139
+ * @memberof SchemasApiContribute
7140
+ */
7141
+ readonly schemaId: string;
7142
+ }
7208
7143
  /**
7209
7144
  * Request parameters for createSchema operation in SchemasApi.
7210
7145
  * @export
@@ -7936,6 +7871,15 @@ export interface SchemasApiUpdateSchemaVariantRequest {
7936
7871
  * @extends {BaseAPI}
7937
7872
  */
7938
7873
  export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
7874
+ /**
7875
+ *
7876
+ * @summary Contribute the default variant of a schema to the module index
7877
+ * @param {SchemasApiContributeRequest} requestParameters Request parameters.
7878
+ * @param {*} [options] Override http request option.
7879
+ * @throws {RequiredError}
7880
+ * @memberof SchemasApi
7881
+ */
7882
+ contribute(requestParameters: SchemasApiContributeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
7939
7883
  /**
7940
7884
  *
7941
7885
  * @summary Create a schema and it\'s default variant
@@ -8667,6 +8611,14 @@ export declare const WorkspaceManagementApiAxiosParamCreator: (configuration?: C
8667
8611
  * @throws {RequiredError}
8668
8612
  */
8669
8613
  inviteMember: (workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8614
+ /**
8615
+ *
8616
+ * @summary Leave a workspace (remove yourself)
8617
+ * @param {string} workspaceId Workspace identifier
8618
+ * @param {*} [options] Override http request option.
8619
+ * @throws {RequiredError}
8620
+ */
8621
+ leaveWorkspace: (workspaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8670
8622
  /**
8671
8623
  *
8672
8624
  * @summary List all members of a workspace
@@ -8748,6 +8700,14 @@ export declare const WorkspaceManagementApiFp: (configuration?: Configuration) =
8748
8700
  * @throws {RequiredError}
8749
8701
  */
8750
8702
  inviteMember(workspaceId: string, inviteMemberRequest: InviteMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
8703
+ /**
8704
+ *
8705
+ * @summary Leave a workspace (remove yourself)
8706
+ * @param {string} workspaceId Workspace identifier
8707
+ * @param {*} [options] Override http request option.
8708
+ * @throws {RequiredError}
8709
+ */
8710
+ leaveWorkspace(workspaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Member>>>;
8751
8711
  /**
8752
8712
  *
8753
8713
  * @summary List all members of a workspace
@@ -8828,6 +8788,14 @@ export declare const WorkspaceManagementApiFactory: (configuration?: Configurati
8828
8788
  * @throws {RequiredError}
8829
8789
  */
8830
8790
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8791
+ /**
8792
+ *
8793
+ * @summary Leave a workspace (remove yourself)
8794
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
8795
+ * @param {*} [options] Override http request option.
8796
+ * @throws {RequiredError}
8797
+ */
8798
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8831
8799
  /**
8832
8800
  *
8833
8801
  * @summary List all members of a workspace
@@ -8910,6 +8878,15 @@ export interface WorkspaceManagementApiInterface {
8910
8878
  * @memberof WorkspaceManagementApiInterface
8911
8879
  */
8912
8880
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8881
+ /**
8882
+ *
8883
+ * @summary Leave a workspace (remove yourself)
8884
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
8885
+ * @param {*} [options] Override http request option.
8886
+ * @throws {RequiredError}
8887
+ * @memberof WorkspaceManagementApiInterface
8888
+ */
8889
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<Member>>;
8913
8890
  /**
8914
8891
  *
8915
8892
  * @summary List all members of a workspace
@@ -9013,6 +8990,19 @@ export interface WorkspaceManagementApiInviteMemberRequest {
9013
8990
  */
9014
8991
  readonly inviteMemberRequest: InviteMemberRequest;
9015
8992
  }
8993
+ /**
8994
+ * Request parameters for leaveWorkspace operation in WorkspaceManagementApi.
8995
+ * @export
8996
+ * @interface WorkspaceManagementApiLeaveWorkspaceRequest
8997
+ */
8998
+ export interface WorkspaceManagementApiLeaveWorkspaceRequest {
8999
+ /**
9000
+ * Workspace identifier
9001
+ * @type {string}
9002
+ * @memberof WorkspaceManagementApiLeaveWorkspace
9003
+ */
9004
+ readonly workspaceId: string;
9005
+ }
9016
9006
  /**
9017
9007
  * Request parameters for listMembers operation in WorkspaceManagementApi.
9018
9008
  * @export
@@ -9126,6 +9116,15 @@ export declare class WorkspaceManagementApi extends BaseAPI implements Workspace
9126
9116
  * @memberof WorkspaceManagementApi
9127
9117
  */
9128
9118
  inviteMember(requestParameters: WorkspaceManagementApiInviteMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
9119
+ /**
9120
+ *
9121
+ * @summary Leave a workspace (remove yourself)
9122
+ * @param {WorkspaceManagementApiLeaveWorkspaceRequest} requestParameters Request parameters.
9123
+ * @param {*} [options] Override http request option.
9124
+ * @throws {RequiredError}
9125
+ * @memberof WorkspaceManagementApi
9126
+ */
9127
+ leaveWorkspace(requestParameters: WorkspaceManagementApiLeaveWorkspaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Member[], any, {}>>;
9129
9128
  /**
9130
9129
  *
9131
9130
  * @summary List all members of a workspace