@wandelbots/nova-api 25.4.0-rc.3 → 25.5.0-dev.10

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/v2/api.d.ts CHANGED
@@ -193,7 +193,7 @@ export interface AllJointPositionsResponse {
193
193
  */
194
194
  export interface App {
195
195
  /**
196
- * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name).
196
+ * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
197
197
  * @type {string}
198
198
  * @memberof App
199
199
  */
@@ -1797,28 +1797,28 @@ export interface GetModeResponse {
1797
1797
  /**
1798
1798
  *
1799
1799
  * @export
1800
- * @interface HTTPExceptionResponse
1800
+ * @interface HTTPValidationError
1801
1801
  */
1802
- export interface HTTPExceptionResponse {
1802
+ export interface HTTPValidationError {
1803
1803
  /**
1804
- * A message describing the error.
1805
- * @type {string}
1806
- * @memberof HTTPExceptionResponse
1804
+ *
1805
+ * @type {Array<ValidationError>}
1806
+ * @memberof HTTPValidationError
1807
1807
  */
1808
- 'detail': string;
1808
+ 'detail'?: Array<ValidationError>;
1809
1809
  }
1810
1810
  /**
1811
1811
  *
1812
1812
  * @export
1813
- * @interface HTTPValidationError
1813
+ * @interface HTTPValidationError2
1814
1814
  */
1815
- export interface HTTPValidationError {
1815
+ export interface HTTPValidationError2 {
1816
1816
  /**
1817
1817
  *
1818
- * @type {Array<ValidationError>}
1819
- * @memberof HTTPValidationError
1818
+ * @type {Array<ValidationError2>}
1819
+ * @memberof HTTPValidationError2
1820
1820
  */
1821
- 'detail'?: Array<ValidationError>;
1821
+ 'detail'?: Array<ValidationError2>;
1822
1822
  }
1823
1823
  /**
1824
1824
  * Input/Output boolean value representation.
@@ -2988,19 +2988,6 @@ export interface ListPayloadsResponse {
2988
2988
  */
2989
2989
  'payloads'?: Array<Payload>;
2990
2990
  }
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
2991
  /**
3005
2992
  *
3006
2993
  * @export
@@ -4433,49 +4420,6 @@ export interface PoseInCoordinateSystem {
4433
4420
  */
4434
4421
  'coordinate_system'?: string;
4435
4422
  }
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
4423
  /**
4480
4424
  *
4481
4425
  * @export
@@ -5875,31 +5819,6 @@ export interface UpdateNovaVersionRequest {
5875
5819
  */
5876
5820
  'channel': ReleaseChannel;
5877
5821
  }
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
5822
  /**
5904
5823
  *
5905
5824
  * @export
@@ -5953,10 +5872,40 @@ export interface ValidationError {
5953
5872
  /**
5954
5873
  *
5955
5874
  * @export
5956
- * @interface ValidationErrorLocInner
5875
+ * @interface ValidationError2
5876
+ */
5877
+ export interface ValidationError2 {
5878
+ /**
5879
+ *
5880
+ * @type {Array<ValidationError2LocInner>}
5881
+ * @memberof ValidationError2
5882
+ */
5883
+ 'loc': Array<ValidationError2LocInner>;
5884
+ /**
5885
+ *
5886
+ * @type {string}
5887
+ * @memberof ValidationError2
5888
+ */
5889
+ 'msg': string;
5890
+ /**
5891
+ *
5892
+ * @type {string}
5893
+ * @memberof ValidationError2
5894
+ */
5895
+ 'type': string;
5896
+ }
5897
+ /**
5898
+ *
5899
+ * @export
5900
+ * @interface ValidationError2LocInner
5957
5901
  */
5958
- export interface ValidationErrorLocInner {
5902
+ export interface ValidationError2LocInner {
5959
5903
  }
5904
+ /**
5905
+ * @type ValidationErrorLocInner
5906
+ * @export
5907
+ */
5908
+ export type ValidationErrorLocInner = number | string;
5960
5909
  /**
5961
5910
  * A generic representation of a version number.
5962
5911
  * @export
@@ -9100,407 +9049,6 @@ export declare class ProgramApi extends BaseAPI {
9100
9049
  */
9101
9050
  stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9102
9051
  }
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 &#x60;is_hidden&#x60; 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 &#x60;is_hidden&#x60; 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 &#x60;is_hidden&#x60; 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 &#x60;is_hidden&#x60; 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
9052
  /**
9505
9053
  * ProgramOperatorApi - axios parameter creator
9506
9054
  * @export
@@ -10842,6 +10390,192 @@ export declare class StoreObjectApi extends BaseAPI {
10842
10390
  [key: string]: string;
10843
10391
  }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10844
10392
  }
10393
+ /**
10394
+ * StoreProgramApi - axios parameter creator
10395
+ * @export
10396
+ */
10397
+ export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
10398
+ /**
10399
+ * Deletes the program. This action is irreversible.
10400
+ * @summary Delete Program
10401
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10402
+ * @param {string} program
10403
+ * @param {*} [options] Override http request option.
10404
+ * @throws {RequiredError}
10405
+ */
10406
+ deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10407
+ /**
10408
+ * Returns the content of the program.
10409
+ * @summary Get Program
10410
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10411
+ * @param {string} program
10412
+ * @param {*} [options] Override http request option.
10413
+ * @throws {RequiredError}
10414
+ */
10415
+ getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10416
+ /**
10417
+ * Returns a list of all the stored programs.
10418
+ * @summary List all Programs
10419
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10420
+ * @param {*} [options] Override http request option.
10421
+ * @throws {RequiredError}
10422
+ */
10423
+ listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10424
+ /**
10425
+ * Stores the content of the program. If the program exists, the operation overwrites the content.
10426
+ * @summary Store Program
10427
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10428
+ * @param {string} program
10429
+ * @param {string} body
10430
+ * @param {{ [key: string]: string; }} [xMetadata]
10431
+ * @param {*} [options] Override http request option.
10432
+ * @throws {RequiredError}
10433
+ */
10434
+ storeProgram: (cell: string, program: string, body: string, xMetadata?: {
10435
+ [key: string]: string;
10436
+ }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10437
+ };
10438
+ /**
10439
+ * StoreProgramApi - functional programming interface
10440
+ * @export
10441
+ */
10442
+ export declare const StoreProgramApiFp: (configuration?: Configuration) => {
10443
+ /**
10444
+ * Deletes the program. This action is irreversible.
10445
+ * @summary Delete Program
10446
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10447
+ * @param {string} program
10448
+ * @param {*} [options] Override http request option.
10449
+ * @throws {RequiredError}
10450
+ */
10451
+ deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10452
+ /**
10453
+ * Returns the content of the program.
10454
+ * @summary Get Program
10455
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10456
+ * @param {string} program
10457
+ * @param {*} [options] Override http request option.
10458
+ * @throws {RequiredError}
10459
+ */
10460
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
10461
+ /**
10462
+ * Returns a list of all the stored programs.
10463
+ * @summary List all Programs
10464
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10465
+ * @param {*} [options] Override http request option.
10466
+ * @throws {RequiredError}
10467
+ */
10468
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
10469
+ /**
10470
+ * Stores the content of the program. If the program exists, the operation overwrites the content.
10471
+ * @summary Store Program
10472
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10473
+ * @param {string} program
10474
+ * @param {string} body
10475
+ * @param {{ [key: string]: string; }} [xMetadata]
10476
+ * @param {*} [options] Override http request option.
10477
+ * @throws {RequiredError}
10478
+ */
10479
+ storeProgram(cell: string, program: string, body: string, xMetadata?: {
10480
+ [key: string]: string;
10481
+ }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10482
+ };
10483
+ /**
10484
+ * StoreProgramApi - factory interface
10485
+ * @export
10486
+ */
10487
+ export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10488
+ /**
10489
+ * Deletes the program. This action is irreversible.
10490
+ * @summary Delete Program
10491
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10492
+ * @param {string} program
10493
+ * @param {*} [options] Override http request option.
10494
+ * @throws {RequiredError}
10495
+ */
10496
+ deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10497
+ /**
10498
+ * Returns the content of the program.
10499
+ * @summary Get Program
10500
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10501
+ * @param {string} program
10502
+ * @param {*} [options] Override http request option.
10503
+ * @throws {RequiredError}
10504
+ */
10505
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
10506
+ /**
10507
+ * Returns a list of all the stored programs.
10508
+ * @summary List all Programs
10509
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10510
+ * @param {*} [options] Override http request option.
10511
+ * @throws {RequiredError}
10512
+ */
10513
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
10514
+ /**
10515
+ * Stores the content of the program. If the program exists, the operation overwrites the content.
10516
+ * @summary Store Program
10517
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10518
+ * @param {string} program
10519
+ * @param {string} body
10520
+ * @param {{ [key: string]: string; }} [xMetadata]
10521
+ * @param {*} [options] Override http request option.
10522
+ * @throws {RequiredError}
10523
+ */
10524
+ storeProgram(cell: string, program: string, body: string, xMetadata?: {
10525
+ [key: string]: string;
10526
+ }, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10527
+ };
10528
+ /**
10529
+ * StoreProgramApi - object-oriented interface
10530
+ * @export
10531
+ * @class StoreProgramApi
10532
+ * @extends {BaseAPI}
10533
+ */
10534
+ export declare class StoreProgramApi extends BaseAPI {
10535
+ /**
10536
+ * Deletes the program. This action is irreversible.
10537
+ * @summary Delete Program
10538
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10539
+ * @param {string} program
10540
+ * @param {*} [options] Override http request option.
10541
+ * @throws {RequiredError}
10542
+ * @memberof StoreProgramApi
10543
+ */
10544
+ deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10545
+ /**
10546
+ * Returns the content of the program.
10547
+ * @summary Get Program
10548
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10549
+ * @param {string} program
10550
+ * @param {*} [options] Override http request option.
10551
+ * @throws {RequiredError}
10552
+ * @memberof StoreProgramApi
10553
+ */
10554
+ getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
10555
+ /**
10556
+ * Returns a list of all the stored programs.
10557
+ * @summary List all Programs
10558
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10559
+ * @param {*} [options] Override http request option.
10560
+ * @throws {RequiredError}
10561
+ * @memberof StoreProgramApi
10562
+ */
10563
+ listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
10564
+ /**
10565
+ * Stores the content of the program. If the program exists, the operation overwrites the content.
10566
+ * @summary Store Program
10567
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10568
+ * @param {string} program
10569
+ * @param {string} body
10570
+ * @param {{ [key: string]: string; }} [xMetadata]
10571
+ * @param {*} [options] Override http request option.
10572
+ * @throws {RequiredError}
10573
+ * @memberof StoreProgramApi
10574
+ */
10575
+ storeProgram(cell: string, program: string, body: string, xMetadata?: {
10576
+ [key: string]: string;
10577
+ }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10578
+ }
10845
10579
  /**
10846
10580
  * SystemApi - axios parameter creator
10847
10581
  * @export