@aurigma/ng-backoffice-api-client 2.62.12 → 2.65.1

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.
@@ -221,6 +221,21 @@ export interface IProductsManagementApiClient {
221
221
  * @return Success
222
222
  */
223
223
  getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductVariantDto>;
224
+ /**
225
+ * Updates product variant resources.
226
+ * @param id Product identifier.
227
+ * @param productVersionId (optional) Product version identifier.
228
+ * @param tenantId (optional) Tenant identifier.
229
+ * @return Success
230
+ */
231
+ updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<void>;
232
+ /**
233
+ * Validates product variant resources.
234
+ * @param id Product identifier.
235
+ * @param tenantId (optional) Tenant identifier.
236
+ * @return Success
237
+ */
238
+ validateProductVariantResources(id: number, tenantId?: number | null | undefined): Observable<void>;
224
239
  /**
225
240
  * Returns a list of product variant designs.
226
241
  * @param id Product identifier.
@@ -283,6 +298,14 @@ export interface IProductsManagementApiClient {
283
298
  * @return Success
284
299
  */
285
300
  setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Observable<void>;
301
+ /**
302
+ * Set product variants weight. Variants identifiers will be changed.
303
+ * @param id Product identifier.
304
+ * @param tenantId (optional) Tenant identifier.
305
+ * @param body (optional) Set product variants weight operation parameters.
306
+ * @return Success
307
+ */
308
+ setProductVariantWeight(id: number, tenantId?: number | null | undefined, body?: SetProductVariantWeightDto | null | undefined): Observable<void>;
286
309
  /**
287
310
  * Set product variants availability. Variants identifiers will be changed.
288
311
  * @param id Product identifier.
@@ -469,6 +492,23 @@ export declare class ProductsManagementApiClient extends ApiClientBase implement
469
492
  */
470
493
  getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductVariantDto>;
471
494
  protected processGetProductVariant(response: HttpResponseBase): Observable<ProductVariantDto>;
495
+ /**
496
+ * Updates product variant resources.
497
+ * @param id Product identifier.
498
+ * @param productVersionId (optional) Product version identifier.
499
+ * @param tenantId (optional) Tenant identifier.
500
+ * @return Success
501
+ */
502
+ updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<void>;
503
+ protected processUpdateProductVariantResources(response: HttpResponseBase): Observable<void>;
504
+ /**
505
+ * Validates product variant resources.
506
+ * @param id Product identifier.
507
+ * @param tenantId (optional) Tenant identifier.
508
+ * @return Success
509
+ */
510
+ validateProductVariantResources(id: number, tenantId?: number | null | undefined): Observable<void>;
511
+ protected processValidateProductVariantResources(response: HttpResponseBase): Observable<void>;
472
512
  /**
473
513
  * Returns a list of product variant designs.
474
514
  * @param id Product identifier.
@@ -535,6 +575,15 @@ export declare class ProductsManagementApiClient extends ApiClientBase implement
535
575
  */
536
576
  setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Observable<void>;
537
577
  protected processSetProductVariantPrice(response: HttpResponseBase): Observable<void>;
578
+ /**
579
+ * Set product variants weight. Variants identifiers will be changed.
580
+ * @param id Product identifier.
581
+ * @param tenantId (optional) Tenant identifier.
582
+ * @param body (optional) Set product variants weight operation parameters.
583
+ * @return Success
584
+ */
585
+ setProductVariantWeight(id: number, tenantId?: number | null | undefined, body?: SetProductVariantWeightDto | null | undefined): Observable<void>;
586
+ protected processSetProductVariantWeight(response: HttpResponseBase): Observable<void>;
538
587
  /**
539
588
  * Set product variants availability. Variants identifiers will be changed.
540
589
  * @param id Product identifier.
@@ -646,6 +695,172 @@ export declare class ProductsManagementApiClient extends ApiClientBase implement
646
695
  getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfProcessingPipelineDto>;
647
696
  protected processGetAvailableProcessingPipelines(response: HttpResponseBase): Observable<PagedOfProcessingPipelineDto>;
648
697
  }
698
+ export interface IProjectStatusesManagementApiClient {
699
+ /**
700
+ * Returns a list of all existing project statuses.
701
+ * @param tenantId (optional) Tenant identifier.
702
+ * @return Success
703
+ */
704
+ getAll(tenantId?: number | null | undefined): Observable<PagedOfProjectStatusDto>;
705
+ /**
706
+ * Creates a new project status and returns its description.
707
+ * @param tenantId (optional) Tenant identifier.
708
+ * @param body (optional) Status creation parameters.
709
+ * @return Success
710
+ */
711
+ create(tenantId?: number | null | undefined, body?: CreateProjectStatusDto | null | undefined): Observable<ProjectStatusDto>;
712
+ /**
713
+ * Returns a project status by its identifier.
714
+ * @param id Status identifier.
715
+ * @param tenantId (optional) Tenant identifier.
716
+ * @return Success
717
+ */
718
+ get(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusDto>;
719
+ /**
720
+ * Updates an existing project status and returns its description.
721
+ * @param id Status identifier.
722
+ * @param tenantId (optional) Tenant identifier.
723
+ * @param body (optional) Status update parameters.
724
+ * @return Success
725
+ */
726
+ update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusDto | null | undefined): Observable<ProjectStatusDto>;
727
+ /**
728
+ * Deletes an existing project status and returns its description.
729
+ * @param id Status identifier.
730
+ * @param tenantId (optional) Tenant identifier.
731
+ * @return Success
732
+ */
733
+ delete(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusDto>;
734
+ }
735
+ export declare class ProjectStatusesManagementApiClient extends ApiClientBase implements IProjectStatusesManagementApiClient {
736
+ private http;
737
+ private baseUrl;
738
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
739
+ constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
740
+ /**
741
+ * Returns a list of all existing project statuses.
742
+ * @param tenantId (optional) Tenant identifier.
743
+ * @return Success
744
+ */
745
+ getAll(tenantId?: number | null | undefined): Observable<PagedOfProjectStatusDto>;
746
+ protected processGetAll(response: HttpResponseBase): Observable<PagedOfProjectStatusDto>;
747
+ /**
748
+ * Creates a new project status and returns its description.
749
+ * @param tenantId (optional) Tenant identifier.
750
+ * @param body (optional) Status creation parameters.
751
+ * @return Success
752
+ */
753
+ create(tenantId?: number | null | undefined, body?: CreateProjectStatusDto | null | undefined): Observable<ProjectStatusDto>;
754
+ protected processCreate(response: HttpResponseBase): Observable<ProjectStatusDto>;
755
+ /**
756
+ * Returns a project status by its identifier.
757
+ * @param id Status identifier.
758
+ * @param tenantId (optional) Tenant identifier.
759
+ * @return Success
760
+ */
761
+ get(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusDto>;
762
+ protected processGet(response: HttpResponseBase): Observable<ProjectStatusDto>;
763
+ /**
764
+ * Updates an existing project status and returns its description.
765
+ * @param id Status identifier.
766
+ * @param tenantId (optional) Tenant identifier.
767
+ * @param body (optional) Status update parameters.
768
+ * @return Success
769
+ */
770
+ update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusDto | null | undefined): Observable<ProjectStatusDto>;
771
+ protected processUpdate(response: HttpResponseBase): Observable<ProjectStatusDto>;
772
+ /**
773
+ * Deletes an existing project status and returns its description.
774
+ * @param id Status identifier.
775
+ * @param tenantId (optional) Tenant identifier.
776
+ * @return Success
777
+ */
778
+ delete(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusDto>;
779
+ protected processDelete(response: HttpResponseBase): Observable<ProjectStatusDto>;
780
+ }
781
+ export interface IProjectStatusTransitionsManagementApiClient {
782
+ /**
783
+ * Returns a list of all existing project status transitions.
784
+ * @param tenantId (optional) Tenant identifier.
785
+ * @return Success
786
+ */
787
+ getAll(tenantId?: number | null | undefined): Observable<PagedOfProjectStatusTransitionDto>;
788
+ /**
789
+ * Returns a project status transition by its identifier.
790
+ * @param id Status transition identifier.
791
+ * @param tenantId (optional) Tenant identifier.
792
+ * @return Success
793
+ */
794
+ get(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusTransitionDto>;
795
+ /**
796
+ * Updates an existing project status transition and returns its description.
797
+ * @param id Status transition identifier.
798
+ * @param tenantId (optional) Tenant identifier.
799
+ * @param body (optional) Status transition update parameters.
800
+ * @return Success
801
+ */
802
+ update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusTransitionDto | null | undefined): Observable<ProjectStatusTransitionDto>;
803
+ /**
804
+ * Deletes an existing project status transition and returns its description.
805
+ * @param id Status transition identifier.
806
+ * @param tenantId (optional) Tenant identifier.
807
+ * @return Success
808
+ */
809
+ delete(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusTransitionDto>;
810
+ /**
811
+ * Creates a new project status transition and returns its description.
812
+ * @param tenantId (optional) Tenant identifier.
813
+ * @param body (optional) Status transition creation parameters.
814
+ * @return Success
815
+ */
816
+ create(tenantId?: number | null | undefined, body?: CreateProjectStatusTransitionDto | null | undefined): Observable<ProjectStatusTransitionDto>;
817
+ }
818
+ export declare class ProjectStatusTransitionsManagementApiClient extends ApiClientBase implements IProjectStatusTransitionsManagementApiClient {
819
+ private http;
820
+ private baseUrl;
821
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
822
+ constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
823
+ /**
824
+ * Returns a list of all existing project status transitions.
825
+ * @param tenantId (optional) Tenant identifier.
826
+ * @return Success
827
+ */
828
+ getAll(tenantId?: number | null | undefined): Observable<PagedOfProjectStatusTransitionDto>;
829
+ protected processGetAll(response: HttpResponseBase): Observable<PagedOfProjectStatusTransitionDto>;
830
+ /**
831
+ * Returns a project status transition by its identifier.
832
+ * @param id Status transition identifier.
833
+ * @param tenantId (optional) Tenant identifier.
834
+ * @return Success
835
+ */
836
+ get(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusTransitionDto>;
837
+ protected processGet(response: HttpResponseBase): Observable<ProjectStatusTransitionDto>;
838
+ /**
839
+ * Updates an existing project status transition and returns its description.
840
+ * @param id Status transition identifier.
841
+ * @param tenantId (optional) Tenant identifier.
842
+ * @param body (optional) Status transition update parameters.
843
+ * @return Success
844
+ */
845
+ update(id: number, tenantId?: number | null | undefined, body?: UpdateProjectStatusTransitionDto | null | undefined): Observable<ProjectStatusTransitionDto>;
846
+ protected processUpdate(response: HttpResponseBase): Observable<ProjectStatusTransitionDto>;
847
+ /**
848
+ * Deletes an existing project status transition and returns its description.
849
+ * @param id Status transition identifier.
850
+ * @param tenantId (optional) Tenant identifier.
851
+ * @return Success
852
+ */
853
+ delete(id: number, tenantId?: number | null | undefined): Observable<ProjectStatusTransitionDto>;
854
+ protected processDelete(response: HttpResponseBase): Observable<ProjectStatusTransitionDto>;
855
+ /**
856
+ * Creates a new project status transition and returns its description.
857
+ * @param tenantId (optional) Tenant identifier.
858
+ * @param body (optional) Status transition creation parameters.
859
+ * @return Success
860
+ */
861
+ create(tenantId?: number | null | undefined, body?: CreateProjectStatusTransitionDto | null | undefined): Observable<ProjectStatusTransitionDto>;
862
+ protected processCreate(response: HttpResponseBase): Observable<ProjectStatusTransitionDto>;
863
+ }
649
864
  export interface IStorefrontsManagementApiClient {
650
865
  /**
651
866
  * Returns all storefronts, relevant to the specified query parameters.
@@ -654,10 +869,11 @@ export interface IStorefrontsManagementApiClient {
654
869
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
655
870
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
656
871
  * @param search (optional) Search string for partial match.
872
+ * @param status (optional) Storefront status.
657
873
  * @param tenantId (optional) Tenant identifier.
658
874
  * @return Success
659
875
  */
660
- getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
876
+ getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
661
877
  /**
662
878
  * Returns a storefront by identifier.
663
879
  * @param id Storefront identifier.
@@ -755,10 +971,11 @@ export declare class StorefrontsManagementApiClient extends ApiClientBase implem
755
971
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
756
972
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
757
973
  * @param search (optional) Search string for partial match.
974
+ * @param status (optional) Storefront status.
758
975
  * @param tenantId (optional) Tenant identifier.
759
976
  * @return Success
760
977
  */
761
- getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
978
+ getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Observable<PagedOfStorefrontDto>;
762
979
  protected processGetAll(response: HttpResponseBase): Observable<PagedOfStorefrontDto>;
763
980
  /**
764
981
  * Returns a storefront by identifier.
@@ -1320,6 +1537,8 @@ export interface ProductVariantDto {
1320
1537
  isAvailable?: boolean;
1321
1538
  /** Product variant price. */
1322
1539
  price?: number | null;
1540
+ /** Product variant weight. */
1541
+ weight?: number | null;
1323
1542
  /** Product variant sort index. */
1324
1543
  sortIndex?: number;
1325
1544
  /** Product variant identifier (usually SKU) in storefront / online store. */
@@ -1502,6 +1721,18 @@ export interface SetProductVariantPriceDto {
1502
1721
  /** List of product variants grouped by price value. */
1503
1722
  items?: ProductVariantPriceDto[] | null;
1504
1723
  }
1724
+ /** Parameters for setting product variants weight. */
1725
+ export interface ProductVariantWeightDto {
1726
+ /** Weight. */
1727
+ weight?: number | null;
1728
+ /** UIDs of variants for price setting. */
1729
+ variantUIDs?: string[] | null;
1730
+ }
1731
+ /** Product variants weight setting operation parameters. */
1732
+ export interface SetProductVariantWeightDto {
1733
+ /** List of product variants grouped by weight value. */
1734
+ items?: ProductVariantWeightDto[] | null;
1735
+ }
1505
1736
  /** Parameters for setting product variants availability. */
1506
1737
  export interface ProductVariantAvailabilityDto {
1507
1738
  /** Availability. */
@@ -1634,6 +1865,92 @@ export interface PagedOfProcessingPipelineDto {
1634
1865
  total?: number;
1635
1866
  items?: ProcessingPipelineDto[] | null;
1636
1867
  }
1868
+ /** Project status parameters. */
1869
+ export interface ProjectStatusDto {
1870
+ /** Project status identifier. */
1871
+ id?: number;
1872
+ /** Status code. */
1873
+ code?: number;
1874
+ /** Status mark color. */
1875
+ color?: string | null;
1876
+ /** Status display name. */
1877
+ displayName?: string | null;
1878
+ /** Indicates if status is initial for all projects. Only one status may be used as initial. */
1879
+ isInitial?: boolean;
1880
+ /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
1881
+ isFinal?: boolean;
1882
+ }
1883
+ /** DTO, containing results of paged query. */
1884
+ export interface PagedOfProjectStatusDto {
1885
+ total?: number;
1886
+ items?: ProjectStatusDto[] | null;
1887
+ }
1888
+ /** Project status creation parameters. */
1889
+ export interface CreateProjectStatusDto {
1890
+ /** Status code. */
1891
+ code?: number;
1892
+ /** Status mark color. */
1893
+ color?: string | null;
1894
+ /** Status display name. */
1895
+ displayName?: string | null;
1896
+ /** Indicates if status is initial for all projects. Only one status may be used as initial. */
1897
+ isInitial?: boolean;
1898
+ /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
1899
+ isFinal?: boolean;
1900
+ }
1901
+ /** Project status update parameters. */
1902
+ export interface UpdateProjectStatusDto {
1903
+ /** Status code. */
1904
+ code?: number;
1905
+ /** Status mark color. */
1906
+ color?: string | null;
1907
+ /** Status display name. */
1908
+ displayName?: string | null;
1909
+ /** Indicates if status is initial for all projects. Only one status may be used as initial. */
1910
+ isInitial?: boolean;
1911
+ /** Indicates if status is final. Multiple statuses may be used as final (e.g. Completed, Rejected etc). */
1912
+ isFinal?: boolean;
1913
+ }
1914
+ /** Project status transition dto class. */
1915
+ export interface ProjectStatusTransitionDto {
1916
+ /** Transition identifier. */
1917
+ id?: number;
1918
+ /** Transition identifying name. */
1919
+ name?: string | null;
1920
+ /** Transition display name. */
1921
+ displayName?: string | null;
1922
+ /** Project status code from which transition to the result status code can be done. */
1923
+ startStatus?: number;
1924
+ /** Transition result project status code. */
1925
+ resultStatus?: number;
1926
+ }
1927
+ /** DTO, containing results of paged query. */
1928
+ export interface PagedOfProjectStatusTransitionDto {
1929
+ total?: number;
1930
+ items?: ProjectStatusTransitionDto[] | null;
1931
+ }
1932
+ /** Project status transition update parameters. */
1933
+ export interface UpdateProjectStatusTransitionDto {
1934
+ /** Transition hidden system name. */
1935
+ name?: string | null;
1936
+ /** Transition display name. */
1937
+ displayName?: string | null;
1938
+ /** Project status code from which transition to the result status code can be done. */
1939
+ startStatus?: number;
1940
+ /** Transition result project status code. */
1941
+ resultStatus?: number;
1942
+ }
1943
+ /** Project status transition creation parameters. */
1944
+ export interface CreateProjectStatusTransitionDto {
1945
+ /** Transition hidden system name. */
1946
+ name?: string | null;
1947
+ /** Transition display name. */
1948
+ displayName?: string | null;
1949
+ /** Project status code from which transition to the result status code can be done. */
1950
+ startStatus?: number;
1951
+ /** Transition result project status code. */
1952
+ resultStatus?: number;
1953
+ }
1637
1954
  /** Storefront types. */
1638
1955
  export declare enum StorefrontType {
1639
1956
  Custom = "Custom",
@@ -1647,6 +1964,11 @@ export declare enum StorefrontType {
1647
1964
  Shopify = "Shopify",
1648
1965
  ShopifyCustom = "ShopifyCustom"
1649
1966
  }
1967
+ /** Storefront status. */
1968
+ export declare enum StorefrontStatus {
1969
+ Dev = "Dev",
1970
+ Prod = "Prod"
1971
+ }
1650
1972
  /** Dto class, containing information about a storefront. */
1651
1973
  export interface StorefrontDto {
1652
1974
  /** Storefront identifier. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurigma/ng-backoffice-api-client",
3
- "version": "2.62.12",
3
+ "version": "2.65.1",
4
4
  "license": "SEE LICENSE IN License.md",
5
5
  "description": "Angular API Client for BackOffice API service of Customer's Canvas web-to-print system.",
6
6
  "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",