@wandelbots/nova-api 25.4.0-rc.2 → 25.5.0-dev.3
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/package.json +1 -1
- package/v2/api.d.ts +186 -495
- package/v2/api.js +1452 -1894
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1490 -2078
package/v2/api.d.ts
CHANGED
|
@@ -1794,19 +1794,6 @@ export interface GetModeResponse {
|
|
|
1794
1794
|
*/
|
|
1795
1795
|
'robot_system_mode': RobotSystemMode;
|
|
1796
1796
|
}
|
|
1797
|
-
/**
|
|
1798
|
-
*
|
|
1799
|
-
* @export
|
|
1800
|
-
* @interface HTTPExceptionResponse
|
|
1801
|
-
*/
|
|
1802
|
-
export interface HTTPExceptionResponse {
|
|
1803
|
-
/**
|
|
1804
|
-
* A message describing the error.
|
|
1805
|
-
* @type {string}
|
|
1806
|
-
* @memberof HTTPExceptionResponse
|
|
1807
|
-
*/
|
|
1808
|
-
'detail': string;
|
|
1809
|
-
}
|
|
1810
1797
|
/**
|
|
1811
1798
|
*
|
|
1812
1799
|
* @export
|
|
@@ -2988,19 +2975,6 @@ export interface ListPayloadsResponse {
|
|
|
2988
2975
|
*/
|
|
2989
2976
|
'payloads'?: Array<Payload>;
|
|
2990
2977
|
}
|
|
2991
|
-
/**
|
|
2992
|
-
* List of all the stored programs, represented by their metadata.
|
|
2993
|
-
* @export
|
|
2994
|
-
* @interface ListProgramMetadataResponse
|
|
2995
|
-
*/
|
|
2996
|
-
export interface ListProgramMetadataResponse {
|
|
2997
|
-
/**
|
|
2998
|
-
*
|
|
2999
|
-
* @type {Array<ProgramMetadata>}
|
|
3000
|
-
* @memberof ListProgramMetadataResponse
|
|
3001
|
-
*/
|
|
3002
|
-
'programs': Array<ProgramMetadata>;
|
|
3003
|
-
}
|
|
3004
2978
|
/**
|
|
3005
2979
|
*
|
|
3006
2980
|
* @export
|
|
@@ -4433,49 +4407,6 @@ export interface PoseInCoordinateSystem {
|
|
|
4433
4407
|
*/
|
|
4434
4408
|
'coordinate_system'?: string;
|
|
4435
4409
|
}
|
|
4436
|
-
/**
|
|
4437
|
-
* The metadata of a program.
|
|
4438
|
-
* @export
|
|
4439
|
-
* @interface ProgramMetadata
|
|
4440
|
-
*/
|
|
4441
|
-
export interface ProgramMetadata {
|
|
4442
|
-
/**
|
|
4443
|
-
* The unique identifier of the program.
|
|
4444
|
-
* @type {string}
|
|
4445
|
-
* @memberof ProgramMetadata
|
|
4446
|
-
*/
|
|
4447
|
-
'id': string;
|
|
4448
|
-
/**
|
|
4449
|
-
* The name of the program presented to the enduser.
|
|
4450
|
-
* @type {string}
|
|
4451
|
-
* @memberof ProgramMetadata
|
|
4452
|
-
*/
|
|
4453
|
-
'name': string;
|
|
4454
|
-
/**
|
|
4455
|
-
* The date when the program was created.
|
|
4456
|
-
* @type {string}
|
|
4457
|
-
* @memberof ProgramMetadata
|
|
4458
|
-
*/
|
|
4459
|
-
'created_date': string;
|
|
4460
|
-
/**
|
|
4461
|
-
* The date when the program was last updated.
|
|
4462
|
-
* @type {string}
|
|
4463
|
-
* @memberof ProgramMetadata
|
|
4464
|
-
*/
|
|
4465
|
-
'last_updated_date': string;
|
|
4466
|
-
/**
|
|
4467
|
-
* Whether the program is accessible for the enduser or only for the developer.
|
|
4468
|
-
* @type {boolean}
|
|
4469
|
-
* @memberof ProgramMetadata
|
|
4470
|
-
*/
|
|
4471
|
-
'is_hidden': boolean;
|
|
4472
|
-
/**
|
|
4473
|
-
* The path to the image of the program
|
|
4474
|
-
* @type {string}
|
|
4475
|
-
* @memberof ProgramMetadata
|
|
4476
|
-
*/
|
|
4477
|
-
'image'?: string;
|
|
4478
|
-
}
|
|
4479
4410
|
/**
|
|
4480
4411
|
*
|
|
4481
4412
|
* @export
|
|
@@ -5875,31 +5806,6 @@ export interface UpdateNovaVersionRequest {
|
|
|
5875
5806
|
*/
|
|
5876
5807
|
'channel': ReleaseChannel;
|
|
5877
5808
|
}
|
|
5878
|
-
/**
|
|
5879
|
-
* This message is used to update the metadata of a program. Only the set fields get updated.
|
|
5880
|
-
* @export
|
|
5881
|
-
* @interface UpdateProgramMetadataRequest
|
|
5882
|
-
*/
|
|
5883
|
-
export interface UpdateProgramMetadataRequest {
|
|
5884
|
-
/**
|
|
5885
|
-
*
|
|
5886
|
-
* @type {string}
|
|
5887
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5888
|
-
*/
|
|
5889
|
-
'name'?: string;
|
|
5890
|
-
/**
|
|
5891
|
-
*
|
|
5892
|
-
* @type {boolean}
|
|
5893
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5894
|
-
*/
|
|
5895
|
-
'is_hidden'?: boolean;
|
|
5896
|
-
/**
|
|
5897
|
-
*
|
|
5898
|
-
* @type {string}
|
|
5899
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5900
|
-
*/
|
|
5901
|
-
'image'?: string;
|
|
5902
|
-
}
|
|
5903
5809
|
/**
|
|
5904
5810
|
*
|
|
5905
5811
|
* @export
|
|
@@ -9100,407 +9006,6 @@ export declare class ProgramApi extends BaseAPI {
|
|
|
9100
9006
|
*/
|
|
9101
9007
|
stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9102
9008
|
}
|
|
9103
|
-
/**
|
|
9104
|
-
* ProgramLibraryApi - axios parameter creator
|
|
9105
|
-
* @export
|
|
9106
|
-
*/
|
|
9107
|
-
export declare const ProgramLibraryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9108
|
-
/**
|
|
9109
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9110
|
-
* @summary Create Program
|
|
9111
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9112
|
-
* @param {string} body
|
|
9113
|
-
* @param {string} [name]
|
|
9114
|
-
* @param {*} [options] Override http request option.
|
|
9115
|
-
* @throws {RequiredError}
|
|
9116
|
-
*/
|
|
9117
|
-
createProgram: (cell: string, body: string, name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9118
|
-
/**
|
|
9119
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9120
|
-
* @summary Delete Program
|
|
9121
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9122
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9123
|
-
* @param {*} [options] Override http request option.
|
|
9124
|
-
* @throws {RequiredError}
|
|
9125
|
-
*/
|
|
9126
|
-
deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9127
|
-
/**
|
|
9128
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9129
|
-
* @summary Delete Program List
|
|
9130
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9131
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9132
|
-
* @param {*} [options] Override http request option.
|
|
9133
|
-
* @throws {RequiredError}
|
|
9134
|
-
*/
|
|
9135
|
-
deleteProgramList: (cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9136
|
-
/**
|
|
9137
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9138
|
-
* @summary Get Program
|
|
9139
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9140
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9141
|
-
* @param {*} [options] Override http request option.
|
|
9142
|
-
* @throws {RequiredError}
|
|
9143
|
-
*/
|
|
9144
|
-
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9145
|
-
/**
|
|
9146
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9147
|
-
* @summary Update Program
|
|
9148
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9149
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9150
|
-
* @param {string} body
|
|
9151
|
-
* @param {*} [options] Override http request option.
|
|
9152
|
-
* @throws {RequiredError}
|
|
9153
|
-
*/
|
|
9154
|
-
updateProgram: (cell: string, program: string, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9155
|
-
};
|
|
9156
|
-
/**
|
|
9157
|
-
* ProgramLibraryApi - functional programming interface
|
|
9158
|
-
* @export
|
|
9159
|
-
*/
|
|
9160
|
-
export declare const ProgramLibraryApiFp: (configuration?: Configuration) => {
|
|
9161
|
-
/**
|
|
9162
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9163
|
-
* @summary Create Program
|
|
9164
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9165
|
-
* @param {string} body
|
|
9166
|
-
* @param {string} [name]
|
|
9167
|
-
* @param {*} [options] Override http request option.
|
|
9168
|
-
* @throws {RequiredError}
|
|
9169
|
-
*/
|
|
9170
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9171
|
-
/**
|
|
9172
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9173
|
-
* @summary Delete Program
|
|
9174
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9175
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9176
|
-
* @param {*} [options] Override http request option.
|
|
9177
|
-
* @throws {RequiredError}
|
|
9178
|
-
*/
|
|
9179
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9180
|
-
/**
|
|
9181
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9182
|
-
* @summary Delete Program List
|
|
9183
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9184
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9185
|
-
* @param {*} [options] Override http request option.
|
|
9186
|
-
* @throws {RequiredError}
|
|
9187
|
-
*/
|
|
9188
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProgramMetadataResponse>>;
|
|
9189
|
-
/**
|
|
9190
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9191
|
-
* @summary Get Program
|
|
9192
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9193
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9194
|
-
* @param {*} [options] Override http request option.
|
|
9195
|
-
* @throws {RequiredError}
|
|
9196
|
-
*/
|
|
9197
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
9198
|
-
/**
|
|
9199
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9200
|
-
* @summary Update Program
|
|
9201
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9202
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9203
|
-
* @param {string} body
|
|
9204
|
-
* @param {*} [options] Override http request option.
|
|
9205
|
-
* @throws {RequiredError}
|
|
9206
|
-
*/
|
|
9207
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9208
|
-
};
|
|
9209
|
-
/**
|
|
9210
|
-
* ProgramLibraryApi - factory interface
|
|
9211
|
-
* @export
|
|
9212
|
-
*/
|
|
9213
|
-
export declare const ProgramLibraryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9214
|
-
/**
|
|
9215
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9216
|
-
* @summary Create Program
|
|
9217
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9218
|
-
* @param {string} body
|
|
9219
|
-
* @param {string} [name]
|
|
9220
|
-
* @param {*} [options] Override http request option.
|
|
9221
|
-
* @throws {RequiredError}
|
|
9222
|
-
*/
|
|
9223
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9224
|
-
/**
|
|
9225
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9226
|
-
* @summary Delete Program
|
|
9227
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9228
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9229
|
-
* @param {*} [options] Override http request option.
|
|
9230
|
-
* @throws {RequiredError}
|
|
9231
|
-
*/
|
|
9232
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9233
|
-
/**
|
|
9234
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9235
|
-
* @summary Delete Program List
|
|
9236
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9237
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9238
|
-
* @param {*} [options] Override http request option.
|
|
9239
|
-
* @throws {RequiredError}
|
|
9240
|
-
*/
|
|
9241
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ListProgramMetadataResponse>;
|
|
9242
|
-
/**
|
|
9243
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9244
|
-
* @summary Get Program
|
|
9245
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9246
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9247
|
-
* @param {*} [options] Override http request option.
|
|
9248
|
-
* @throws {RequiredError}
|
|
9249
|
-
*/
|
|
9250
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
9251
|
-
/**
|
|
9252
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9253
|
-
* @summary Update Program
|
|
9254
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9255
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9256
|
-
* @param {string} body
|
|
9257
|
-
* @param {*} [options] Override http request option.
|
|
9258
|
-
* @throws {RequiredError}
|
|
9259
|
-
*/
|
|
9260
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9261
|
-
};
|
|
9262
|
-
/**
|
|
9263
|
-
* ProgramLibraryApi - object-oriented interface
|
|
9264
|
-
* @export
|
|
9265
|
-
* @class ProgramLibraryApi
|
|
9266
|
-
* @extends {BaseAPI}
|
|
9267
|
-
*/
|
|
9268
|
-
export declare class ProgramLibraryApi extends BaseAPI {
|
|
9269
|
-
/**
|
|
9270
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9271
|
-
* @summary Create Program
|
|
9272
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9273
|
-
* @param {string} body
|
|
9274
|
-
* @param {string} [name]
|
|
9275
|
-
* @param {*} [options] Override http request option.
|
|
9276
|
-
* @throws {RequiredError}
|
|
9277
|
-
* @memberof ProgramLibraryApi
|
|
9278
|
-
*/
|
|
9279
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9280
|
-
/**
|
|
9281
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9282
|
-
* @summary Delete Program
|
|
9283
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9284
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9285
|
-
* @param {*} [options] Override http request option.
|
|
9286
|
-
* @throws {RequiredError}
|
|
9287
|
-
* @memberof ProgramLibraryApi
|
|
9288
|
-
*/
|
|
9289
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9290
|
-
/**
|
|
9291
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9292
|
-
* @summary Delete Program List
|
|
9293
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9294
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9295
|
-
* @param {*} [options] Override http request option.
|
|
9296
|
-
* @throws {RequiredError}
|
|
9297
|
-
* @memberof ProgramLibraryApi
|
|
9298
|
-
*/
|
|
9299
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9300
|
-
/**
|
|
9301
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9302
|
-
* @summary Get Program
|
|
9303
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9304
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9305
|
-
* @param {*} [options] Override http request option.
|
|
9306
|
-
* @throws {RequiredError}
|
|
9307
|
-
* @memberof ProgramLibraryApi
|
|
9308
|
-
*/
|
|
9309
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
9310
|
-
/**
|
|
9311
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9312
|
-
* @summary Update Program
|
|
9313
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9314
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9315
|
-
* @param {string} body
|
|
9316
|
-
* @param {*} [options] Override http request option.
|
|
9317
|
-
* @throws {RequiredError}
|
|
9318
|
-
* @memberof ProgramLibraryApi
|
|
9319
|
-
*/
|
|
9320
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9321
|
-
}
|
|
9322
|
-
/**
|
|
9323
|
-
* ProgramLibraryMetadataApi - axios parameter creator
|
|
9324
|
-
* @export
|
|
9325
|
-
*/
|
|
9326
|
-
export declare const ProgramLibraryMetadataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9327
|
-
/**
|
|
9328
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9329
|
-
* @summary Get Program Metadata
|
|
9330
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9331
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9332
|
-
* @param {*} [options] Override http request option.
|
|
9333
|
-
* @throws {RequiredError}
|
|
9334
|
-
*/
|
|
9335
|
-
getProgramMetadata: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9336
|
-
/**
|
|
9337
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9338
|
-
* @summary List Program Metadata
|
|
9339
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9340
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9341
|
-
* @param {*} [options] Override http request option.
|
|
9342
|
-
* @throws {RequiredError}
|
|
9343
|
-
*/
|
|
9344
|
-
listProgramMetadata: (cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9345
|
-
/**
|
|
9346
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9347
|
-
* @summary Update Program Metadata
|
|
9348
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9349
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9350
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9351
|
-
* @param {*} [options] Override http request option.
|
|
9352
|
-
* @throws {RequiredError}
|
|
9353
|
-
*/
|
|
9354
|
-
updateProgramMetadata: (cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9355
|
-
/**
|
|
9356
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9357
|
-
* @summary Upload Program Metadata Image
|
|
9358
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9359
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9360
|
-
* @param {File} file
|
|
9361
|
-
* @param {*} [options] Override http request option.
|
|
9362
|
-
* @throws {RequiredError}
|
|
9363
|
-
*/
|
|
9364
|
-
uploadProgramMetadataImage: (cell: string, program: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9365
|
-
};
|
|
9366
|
-
/**
|
|
9367
|
-
* ProgramLibraryMetadataApi - functional programming interface
|
|
9368
|
-
* @export
|
|
9369
|
-
*/
|
|
9370
|
-
export declare const ProgramLibraryMetadataApiFp: (configuration?: Configuration) => {
|
|
9371
|
-
/**
|
|
9372
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9373
|
-
* @summary Get Program Metadata
|
|
9374
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9375
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9376
|
-
* @param {*} [options] Override http request option.
|
|
9377
|
-
* @throws {RequiredError}
|
|
9378
|
-
*/
|
|
9379
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9380
|
-
/**
|
|
9381
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9382
|
-
* @summary List Program Metadata
|
|
9383
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9384
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9385
|
-
* @param {*} [options] Override http request option.
|
|
9386
|
-
* @throws {RequiredError}
|
|
9387
|
-
*/
|
|
9388
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProgramMetadataResponse>>;
|
|
9389
|
-
/**
|
|
9390
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9391
|
-
* @summary Update Program Metadata
|
|
9392
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9393
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9394
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9395
|
-
* @param {*} [options] Override http request option.
|
|
9396
|
-
* @throws {RequiredError}
|
|
9397
|
-
*/
|
|
9398
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9399
|
-
/**
|
|
9400
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9401
|
-
* @summary Upload Program Metadata Image
|
|
9402
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9403
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9404
|
-
* @param {File} file
|
|
9405
|
-
* @param {*} [options] Override http request option.
|
|
9406
|
-
* @throws {RequiredError}
|
|
9407
|
-
*/
|
|
9408
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9409
|
-
};
|
|
9410
|
-
/**
|
|
9411
|
-
* ProgramLibraryMetadataApi - factory interface
|
|
9412
|
-
* @export
|
|
9413
|
-
*/
|
|
9414
|
-
export declare const ProgramLibraryMetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9415
|
-
/**
|
|
9416
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9417
|
-
* @summary Get Program Metadata
|
|
9418
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9419
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9420
|
-
* @param {*} [options] Override http request option.
|
|
9421
|
-
* @throws {RequiredError}
|
|
9422
|
-
*/
|
|
9423
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9424
|
-
/**
|
|
9425
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9426
|
-
* @summary List Program Metadata
|
|
9427
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9428
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9429
|
-
* @param {*} [options] Override http request option.
|
|
9430
|
-
* @throws {RequiredError}
|
|
9431
|
-
*/
|
|
9432
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ListProgramMetadataResponse>;
|
|
9433
|
-
/**
|
|
9434
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9435
|
-
* @summary Update Program Metadata
|
|
9436
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9437
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9438
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9439
|
-
* @param {*} [options] Override http request option.
|
|
9440
|
-
* @throws {RequiredError}
|
|
9441
|
-
*/
|
|
9442
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9443
|
-
/**
|
|
9444
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9445
|
-
* @summary Upload Program Metadata Image
|
|
9446
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9447
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9448
|
-
* @param {File} file
|
|
9449
|
-
* @param {*} [options] Override http request option.
|
|
9450
|
-
* @throws {RequiredError}
|
|
9451
|
-
*/
|
|
9452
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9453
|
-
};
|
|
9454
|
-
/**
|
|
9455
|
-
* ProgramLibraryMetadataApi - object-oriented interface
|
|
9456
|
-
* @export
|
|
9457
|
-
* @class ProgramLibraryMetadataApi
|
|
9458
|
-
* @extends {BaseAPI}
|
|
9459
|
-
*/
|
|
9460
|
-
export declare class ProgramLibraryMetadataApi extends BaseAPI {
|
|
9461
|
-
/**
|
|
9462
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9463
|
-
* @summary Get Program Metadata
|
|
9464
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9465
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9466
|
-
* @param {*} [options] Override http request option.
|
|
9467
|
-
* @throws {RequiredError}
|
|
9468
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9469
|
-
*/
|
|
9470
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9471
|
-
/**
|
|
9472
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9473
|
-
* @summary List Program Metadata
|
|
9474
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9475
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9476
|
-
* @param {*} [options] Override http request option.
|
|
9477
|
-
* @throws {RequiredError}
|
|
9478
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9479
|
-
*/
|
|
9480
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9481
|
-
/**
|
|
9482
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9483
|
-
* @summary Update Program Metadata
|
|
9484
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9485
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9486
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9487
|
-
* @param {*} [options] Override http request option.
|
|
9488
|
-
* @throws {RequiredError}
|
|
9489
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9490
|
-
*/
|
|
9491
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9492
|
-
/**
|
|
9493
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9494
|
-
* @summary Upload Program Metadata Image
|
|
9495
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9496
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9497
|
-
* @param {File} file
|
|
9498
|
-
* @param {*} [options] Override http request option.
|
|
9499
|
-
* @throws {RequiredError}
|
|
9500
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9501
|
-
*/
|
|
9502
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9503
|
-
}
|
|
9504
9009
|
/**
|
|
9505
9010
|
* ProgramOperatorApi - axios parameter creator
|
|
9506
9011
|
* @export
|
|
@@ -10842,6 +10347,192 @@ export declare class StoreObjectApi extends BaseAPI {
|
|
|
10842
10347
|
[key: string]: string;
|
|
10843
10348
|
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10844
10349
|
}
|
|
10350
|
+
/**
|
|
10351
|
+
* StoreProgramApi - axios parameter creator
|
|
10352
|
+
* @export
|
|
10353
|
+
*/
|
|
10354
|
+
export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10355
|
+
/**
|
|
10356
|
+
* Deletes the program. This action is irreversible.
|
|
10357
|
+
* @summary Delete Program
|
|
10358
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10359
|
+
* @param {string} program
|
|
10360
|
+
* @param {*} [options] Override http request option.
|
|
10361
|
+
* @throws {RequiredError}
|
|
10362
|
+
*/
|
|
10363
|
+
deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10364
|
+
/**
|
|
10365
|
+
* Returns the content of the program.
|
|
10366
|
+
* @summary Get Program
|
|
10367
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10368
|
+
* @param {string} program
|
|
10369
|
+
* @param {*} [options] Override http request option.
|
|
10370
|
+
* @throws {RequiredError}
|
|
10371
|
+
*/
|
|
10372
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10373
|
+
/**
|
|
10374
|
+
* Returns a list of all the stored programs.
|
|
10375
|
+
* @summary List all Programs
|
|
10376
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10377
|
+
* @param {*} [options] Override http request option.
|
|
10378
|
+
* @throws {RequiredError}
|
|
10379
|
+
*/
|
|
10380
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10381
|
+
/**
|
|
10382
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10383
|
+
* @summary Store Program
|
|
10384
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10385
|
+
* @param {string} program
|
|
10386
|
+
* @param {string} body
|
|
10387
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10388
|
+
* @param {*} [options] Override http request option.
|
|
10389
|
+
* @throws {RequiredError}
|
|
10390
|
+
*/
|
|
10391
|
+
storeProgram: (cell: string, program: string, body: string, xMetadata?: {
|
|
10392
|
+
[key: string]: string;
|
|
10393
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10394
|
+
};
|
|
10395
|
+
/**
|
|
10396
|
+
* StoreProgramApi - functional programming interface
|
|
10397
|
+
* @export
|
|
10398
|
+
*/
|
|
10399
|
+
export declare const StoreProgramApiFp: (configuration?: Configuration) => {
|
|
10400
|
+
/**
|
|
10401
|
+
* Deletes the program. This action is irreversible.
|
|
10402
|
+
* @summary Delete Program
|
|
10403
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10404
|
+
* @param {string} program
|
|
10405
|
+
* @param {*} [options] Override http request option.
|
|
10406
|
+
* @throws {RequiredError}
|
|
10407
|
+
*/
|
|
10408
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10409
|
+
/**
|
|
10410
|
+
* Returns the content of the program.
|
|
10411
|
+
* @summary Get Program
|
|
10412
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10413
|
+
* @param {string} program
|
|
10414
|
+
* @param {*} [options] Override http request option.
|
|
10415
|
+
* @throws {RequiredError}
|
|
10416
|
+
*/
|
|
10417
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
10418
|
+
/**
|
|
10419
|
+
* Returns a list of all the stored programs.
|
|
10420
|
+
* @summary List all Programs
|
|
10421
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10422
|
+
* @param {*} [options] Override http request option.
|
|
10423
|
+
* @throws {RequiredError}
|
|
10424
|
+
*/
|
|
10425
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
10426
|
+
/**
|
|
10427
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10428
|
+
* @summary Store Program
|
|
10429
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10430
|
+
* @param {string} program
|
|
10431
|
+
* @param {string} body
|
|
10432
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10433
|
+
* @param {*} [options] Override http request option.
|
|
10434
|
+
* @throws {RequiredError}
|
|
10435
|
+
*/
|
|
10436
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10437
|
+
[key: string]: string;
|
|
10438
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10439
|
+
};
|
|
10440
|
+
/**
|
|
10441
|
+
* StoreProgramApi - factory interface
|
|
10442
|
+
* @export
|
|
10443
|
+
*/
|
|
10444
|
+
export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10445
|
+
/**
|
|
10446
|
+
* Deletes the program. This action is irreversible.
|
|
10447
|
+
* @summary Delete Program
|
|
10448
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10449
|
+
* @param {string} program
|
|
10450
|
+
* @param {*} [options] Override http request option.
|
|
10451
|
+
* @throws {RequiredError}
|
|
10452
|
+
*/
|
|
10453
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10454
|
+
/**
|
|
10455
|
+
* Returns the content of the program.
|
|
10456
|
+
* @summary Get Program
|
|
10457
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10458
|
+
* @param {string} program
|
|
10459
|
+
* @param {*} [options] Override http request option.
|
|
10460
|
+
* @throws {RequiredError}
|
|
10461
|
+
*/
|
|
10462
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
10463
|
+
/**
|
|
10464
|
+
* Returns a list of all the stored programs.
|
|
10465
|
+
* @summary List all Programs
|
|
10466
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10467
|
+
* @param {*} [options] Override http request option.
|
|
10468
|
+
* @throws {RequiredError}
|
|
10469
|
+
*/
|
|
10470
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
10471
|
+
/**
|
|
10472
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10473
|
+
* @summary Store Program
|
|
10474
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10475
|
+
* @param {string} program
|
|
10476
|
+
* @param {string} body
|
|
10477
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10478
|
+
* @param {*} [options] Override http request option.
|
|
10479
|
+
* @throws {RequiredError}
|
|
10480
|
+
*/
|
|
10481
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10482
|
+
[key: string]: string;
|
|
10483
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10484
|
+
};
|
|
10485
|
+
/**
|
|
10486
|
+
* StoreProgramApi - object-oriented interface
|
|
10487
|
+
* @export
|
|
10488
|
+
* @class StoreProgramApi
|
|
10489
|
+
* @extends {BaseAPI}
|
|
10490
|
+
*/
|
|
10491
|
+
export declare class StoreProgramApi extends BaseAPI {
|
|
10492
|
+
/**
|
|
10493
|
+
* Deletes the program. This action is irreversible.
|
|
10494
|
+
* @summary Delete Program
|
|
10495
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10496
|
+
* @param {string} program
|
|
10497
|
+
* @param {*} [options] Override http request option.
|
|
10498
|
+
* @throws {RequiredError}
|
|
10499
|
+
* @memberof StoreProgramApi
|
|
10500
|
+
*/
|
|
10501
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10502
|
+
/**
|
|
10503
|
+
* Returns the content of the program.
|
|
10504
|
+
* @summary Get Program
|
|
10505
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10506
|
+
* @param {string} program
|
|
10507
|
+
* @param {*} [options] Override http request option.
|
|
10508
|
+
* @throws {RequiredError}
|
|
10509
|
+
* @memberof StoreProgramApi
|
|
10510
|
+
*/
|
|
10511
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
10512
|
+
/**
|
|
10513
|
+
* Returns a list of all the stored programs.
|
|
10514
|
+
* @summary List all Programs
|
|
10515
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10516
|
+
* @param {*} [options] Override http request option.
|
|
10517
|
+
* @throws {RequiredError}
|
|
10518
|
+
* @memberof StoreProgramApi
|
|
10519
|
+
*/
|
|
10520
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
10521
|
+
/**
|
|
10522
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10523
|
+
* @summary Store Program
|
|
10524
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10525
|
+
* @param {string} program
|
|
10526
|
+
* @param {string} body
|
|
10527
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10528
|
+
* @param {*} [options] Override http request option.
|
|
10529
|
+
* @throws {RequiredError}
|
|
10530
|
+
* @memberof StoreProgramApi
|
|
10531
|
+
*/
|
|
10532
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10533
|
+
[key: string]: string;
|
|
10534
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10535
|
+
}
|
|
10845
10536
|
/**
|
|
10846
10537
|
* SystemApi - axios parameter creator
|
|
10847
10538
|
* @export
|