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