aurigma-backoffice-api-client 1.0.0__tar.gz

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.
Files changed (106) hide show
  1. aurigma_backoffice_api_client-1.0.0/PKG-INFO +282 -0
  2. aurigma_backoffice_api_client-1.0.0/README.md +271 -0
  3. aurigma_backoffice_api_client-1.0.0/pyproject.toml +23 -0
  4. aurigma_backoffice_api_client-1.0.0/setup.cfg +4 -0
  5. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/__init__.py +222 -0
  6. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/__init__.py +9 -0
  7. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/build_info_api.py +513 -0
  8. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/product_references_management_api.py +1469 -0
  9. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/products_management_api.py +7962 -0
  10. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/storefronts_management_api.py +3930 -0
  11. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api/users_management_api.py +1512 -0
  12. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api_client.py +807 -0
  13. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/api_response.py +21 -0
  14. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/configuration.py +637 -0
  15. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/exceptions.py +219 -0
  16. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/__init__.py +99 -0
  17. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/appearance_data_dto.py +103 -0
  18. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/appearance_data_item_dto.py +99 -0
  19. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/appearance_data_type.py +42 -0
  20. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/big_commerce_settings_dto.py +127 -0
  21. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/big_commerce_storefront_dto.py +134 -0
  22. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/build_info_model.py +113 -0
  23. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/conflict_type.py +39 -0
  24. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_big_commerce_storefront_dto.py +116 -0
  25. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_custom_storefront_dto.py +118 -0
  26. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_magento_storefront_dto.py +115 -0
  27. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_nop_commerce_storefront_dto.py +106 -0
  28. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_design_connections_dto.py +100 -0
  29. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_document_connections_dto.py +100 -0
  30. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_dto.py +127 -0
  31. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_mockup_connections_dto.py +100 -0
  32. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_option_dto.py +115 -0
  33. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_option_value_dto.py +92 -0
  34. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_product_reference_dto.py +125 -0
  35. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_tenant_user_dto.py +105 -0
  36. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/create_woo_commerce_storefront_dto.py +106 -0
  37. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/custom_storefront_dto.py +137 -0
  38. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/general_conflict_dto.py +95 -0
  39. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/image_info.py +99 -0
  40. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/magento_settings_dto.py +117 -0
  41. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/magento_storefront_dto.py +134 -0
  42. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/microsoft_asp_net_core_mvc_problem_details.py +133 -0
  43. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/nop_commerce_settings_dto.py +124 -0
  44. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/nop_commerce_storefront_dto.py +134 -0
  45. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/option_type.py +38 -0
  46. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_personalization_workflow_dto.py +102 -0
  47. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_processing_pipeline_dto.py +102 -0
  48. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_dto.py +102 -0
  49. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_option_dto.py +102 -0
  50. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_reference_dto.py +102 -0
  51. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_variant_design_dto.py +102 -0
  52. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_variant_document_dto.py +102 -0
  53. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_variant_dto.py +102 -0
  54. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_product_variant_mockup_dto.py +102 -0
  55. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_storefront_dto.py +102 -0
  56. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_tenant_user_dto.py +102 -0
  57. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/paged_of_tenant_user_role_dto.py +102 -0
  58. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/personalization_workflow_dto.py +97 -0
  59. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/processing_pipeline_dto.py +94 -0
  60. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_asset_connection_options_dto.py +99 -0
  61. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_design_connection_dto.py +107 -0
  62. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_document_connection_dto.py +107 -0
  63. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_dto.py +165 -0
  64. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_mockup_connection_dto.py +122 -0
  65. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_mockup_type.py +38 -0
  66. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_option_dto.py +183 -0
  67. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_option_value_dto.py +148 -0
  68. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_reference_creation_conflict_dto.py +110 -0
  69. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_reference_dto.py +119 -0
  70. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_reference_info.py +112 -0
  71. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_reference_type.py +39 -0
  72. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_availability_dto.py +94 -0
  73. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_design_dto.py +180 -0
  74. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_document_dto.py +176 -0
  75. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_dto.py +140 -0
  76. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_mockup_dto.py +161 -0
  77. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_mockup_type.py +38 -0
  78. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_option_dto.py +134 -0
  79. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_price_dto.py +99 -0
  80. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_resource_dto.py +120 -0
  81. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_resource_preview.py +113 -0
  82. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_resource_type.py +38 -0
  83. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/product_variant_sku_dto.py +99 -0
  84. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/remove_product_asset_connection_dto.py +107 -0
  85. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/remove_product_design_connections_dto.py +100 -0
  86. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/remove_product_document_connections_dto.py +100 -0
  87. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/remove_product_mockup_connections_dto.py +100 -0
  88. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/set_product_variant_availability_dto.py +100 -0
  89. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/set_product_variant_price_dto.py +100 -0
  90. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/set_product_variant_sku_dto.py +100 -0
  91. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/simple_option_value.py +92 -0
  92. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/storefront_dto.py +123 -0
  93. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/storefront_type.py +45 -0
  94. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/surface_usage_type.py +38 -0
  95. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/tenant_user_dto.py +124 -0
  96. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/tenant_user_role_dto.py +94 -0
  97. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/woo_commerce_settings_dto.py +124 -0
  98. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/woo_commerce_storefront_dto.py +134 -0
  99. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/models/workflow_type.py +39 -0
  100. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/py.typed +0 -0
  101. aurigma_backoffice_api_client-1.0.0/src/aurigma/backoffice/rest.py +199 -0
  102. aurigma_backoffice_api_client-1.0.0/src/aurigma_backoffice_api_client.egg-info/PKG-INFO +282 -0
  103. aurigma_backoffice_api_client-1.0.0/src/aurigma_backoffice_api_client.egg-info/SOURCES.txt +104 -0
  104. aurigma_backoffice_api_client-1.0.0/src/aurigma_backoffice_api_client.egg-info/dependency_links.txt +1 -0
  105. aurigma_backoffice_api_client-1.0.0/src/aurigma_backoffice_api_client.egg-info/requires.txt +6 -0
  106. aurigma_backoffice_api_client-1.0.0/src/aurigma_backoffice_api_client.egg-info/top_level.txt +1 -0
aurigma_backoffice_api_client-1.0.0/PKG-INFO ADDED
@@ -0,0 +1,282 @@
1
+ Metadata-Version: 2.4
2
+ Name: aurigma-backoffice-api-client
3
+ Version: 1.0.0
4
+ Summary: Aurigma BackOffice API client
5
+ Requires-Python: >=3.9
6
+ Description-Content-Type: text/markdown
7
+ Requires-Dist: python-dateutil>=2.8.2
8
+ Requires-Dist: httpx>=0.28.1
9
+ Requires-Dist: pydantic<3,>=2
10
+ Requires-Dist: typing-extensions>=4.7.1; python_version < "3.11"
11
+
12
+ # aurigma-backoffice-api-client
13
+
14
+ Python client library for [Aurigma BackOffice API](https://customerscanvas.com/dev/backoffice/api/backoffice/overview.html).
15
+
16
+ ## Requirements.
17
+
18
+ - Python 3.9+
19
+ - Dependencies:
20
+ - python-dateutil>=2.8.2
21
+ - httpx>=0.28.1
22
+ - pydantic>=2
23
+ - typing-extensions>=4.7.1
24
+
25
+ ## Installation & Usage
26
+ ### pip install
27
+
28
+ ```sh
29
+ pip install aurigma-backoffice-api-client
30
+ ```
31
+
32
+ Then import the package:
33
+ ```python
34
+ import aurigma.backoffice
35
+ ```
36
+
37
+ ## Getting Started
38
+
39
+ Please follow the [installation procedure](#installation--usage) and then run the following:
40
+
41
+ ```python
42
+
43
+ import aurigma.backoffice
44
+ from aurigma.backoffice.rest import ApiException
45
+ from pprint import pprint
46
+
47
+ # See configuration.py for a list of all supported configuration parameters.
48
+ configuration = aurigma.storefront.Configuration(
49
+ host = "http://api.customerscanvashub.com/"
50
+ )
51
+
52
+
53
+
54
+
55
+ # Enter a context with an instance of the API client
56
+ async with aurigma.backoffice.ApiClient(configuration) as api_client:
57
+ # Create an instance of the API class
58
+ api_instance = aurigma.backoffice.BuildInfoApi(api_client)
59
+
60
+ try:
61
+ # Returns assembly build info.
62
+ api_response = await api_instance.build_info_get_info()
63
+ print("The response of BuildInfoApi->build_info_get_info:\n")
64
+ pprint(api_response)
65
+ except ApiException as e:
66
+ print("Exception when calling BuildInfoApi->build_info_get_info: %s\n" % e)
67
+
68
+ ```
69
+
70
+ ## Documentation for API Endpoints
71
+
72
+ Depending on the geographical location of your Customer's Canvas Hub instance, the API gateway address may vary:
73
+
74
+ https://api.customerscanvashub.com/ - United States instance
75
+ https://api.eu.customerscanvashub.com/ - European instance
76
+ https://api.au.customerscanvashub.com/ - Australian instance
77
+
78
+ Class | Method | HTTP request | Description
79
+ ------------ | ------------- | ------------- | -------------
80
+ *BuildInfoApi* | [**build_info_get_info**](docs/BuildInfoApi.md#build_info_get_info) | **GET** /api/backoffice/v1/info | Returns assembly build info.
81
+ *BuildInfoApi* | [**build_info_head_info**](docs/BuildInfoApi.md#build_info_head_info) | **HEAD** /api/backoffice/v1/info | Returns assembly build info.
82
+ *ProductReferencesManagementApi* | [**product_references_management_create**](docs/ProductReferencesManagementApi.md#product_references_management_create) | **POST** /api/backoffice/v1/product-references | Creates a new storefront product reference.
83
+ *ProductReferencesManagementApi* | [**product_references_management_delete**](docs/ProductReferencesManagementApi.md#product_references_management_delete) | **DELETE** /api/backoffice/v1/product-references/{reference} | Deletes the storefront product reference.
84
+ *ProductReferencesManagementApi* | [**product_references_management_get**](docs/ProductReferencesManagementApi.md#product_references_management_get) | **GET** /api/backoffice/v1/product-references/{reference} | Returns a storefront product reference.
85
+ *ProductReferencesManagementApi* | [**product_references_management_get_all**](docs/ProductReferencesManagementApi.md#product_references_management_get_all) | **GET** /api/backoffice/v1/product-references | Returns all storefront product references relevant to the specified query parameters.
86
+ *ProductsManagementApi* | [**products_management_create_designs_connections**](docs/ProductsManagementApi.md#products_management_create_designs_connections) | **POST** /api/backoffice/v1/products/{id}/design-connections | Creates new designs connections for a specified product.
87
+ *ProductsManagementApi* | [**products_management_create_documents_connections**](docs/ProductsManagementApi.md#products_management_create_documents_connections) | **POST** /api/backoffice/v1/products/{id}/document-connections | Creates new documents connections for a specified product.
88
+ *ProductsManagementApi* | [**products_management_create_mockups_connections**](docs/ProductsManagementApi.md#products_management_create_mockups_connections) | **POST** /api/backoffice/v1/products/{id}/mockup-connections | Creates new mockups connections for a specified product.
89
+ *ProductsManagementApi* | [**products_management_create_product**](docs/ProductsManagementApi.md#products_management_create_product) | **POST** /api/backoffice/v1/products | Creates a new product and returns its description.
90
+ *ProductsManagementApi* | [**products_management_delete_product**](docs/ProductsManagementApi.md#products_management_delete_product) | **DELETE** /api/backoffice/v1/products/{id} | Deletes a product by its identifier.
91
+ *ProductsManagementApi* | [**products_management_get_all_products**](docs/ProductsManagementApi.md#products_management_get_all_products) | **GET** /api/backoffice/v1/products | Returns all products, relevant to the specified query parameters.
92
+ *ProductsManagementApi* | [**products_management_get_available_personalization_workflows**](docs/ProductsManagementApi.md#products_management_get_available_personalization_workflows) | **GET** /api/backoffice/v1/products/available-workflows | Returns all available product personalization workflows.
93
+ *ProductsManagementApi* | [**products_management_get_available_processing_pipelines**](docs/ProductsManagementApi.md#products_management_get_available_processing_pipelines) | **GET** /api/backoffice/v1/products/available-pipelines | Returns all available product processing pipelines.
94
+ *ProductsManagementApi* | [**products_management_get_product**](docs/ProductsManagementApi.md#products_management_get_product) | **GET** /api/backoffice/v1/products/{id} | Returns a product by its identifier.
95
+ *ProductsManagementApi* | [**products_management_get_product_options**](docs/ProductsManagementApi.md#products_management_get_product_options) | **GET** /api/backoffice/v1/products/{id}/options | Returns a list of product options.
96
+ *ProductsManagementApi* | [**products_management_get_product_variant**](docs/ProductsManagementApi.md#products_management_get_product_variant) | **GET** /api/backoffice/v1/products/{id}/variants/{productVariantId} | Returns a product variant.
97
+ *ProductsManagementApi* | [**products_management_get_product_variant_designs**](docs/ProductsManagementApi.md#products_management_get_product_variant_designs) | **GET** /api/backoffice/v1/products/{id}/variant-designs | Returns a list of product variant designs.
98
+ *ProductsManagementApi* | [**products_management_get_product_variant_documents**](docs/ProductsManagementApi.md#products_management_get_product_variant_documents) | **GET** /api/backoffice/v1/products/{id}/variant-documents | Returns a list of product variant documents.
99
+ *ProductsManagementApi* | [**products_management_get_product_variant_mockups**](docs/ProductsManagementApi.md#products_management_get_product_variant_mockups) | **GET** /api/backoffice/v1/products/{id}/variant-mockups | Returns a list of product variant mockups.
100
+ *ProductsManagementApi* | [**products_management_get_product_variants**](docs/ProductsManagementApi.md#products_management_get_product_variants) | **GET** /api/backoffice/v1/products/{id}/variants | Returns a list of product variants.
101
+ *ProductsManagementApi* | [**products_management_import_products**](docs/ProductsManagementApi.md#products_management_import_products) | **POST** /api/backoffice/v1/products/import | Imports products from a specific CSV file and returns a list of imported products descriptions.
102
+ *ProductsManagementApi* | [**products_management_remove_designs_connections**](docs/ProductsManagementApi.md#products_management_remove_designs_connections) | **DELETE** /api/backoffice/v1/products/{id}/design-connections | Removes designs connections for a specified product.
103
+ *ProductsManagementApi* | [**products_management_remove_documents_connections**](docs/ProductsManagementApi.md#products_management_remove_documents_connections) | **DELETE** /api/backoffice/v1/products/{id}/document-connections | Removes documents connections for a specified product.
104
+ *ProductsManagementApi* | [**products_management_remove_mockups_connections**](docs/ProductsManagementApi.md#products_management_remove_mockups_connections) | **DELETE** /api/backoffice/v1/products/{id}/mockup-connections | Removes mockups connections for a specified product.
105
+ *ProductsManagementApi* | [**products_management_set_product_image**](docs/ProductsManagementApi.md#products_management_set_product_image) | **POST** /api/backoffice/v1/products/{id}/set-image | Set a thumbnail image for an existing product.
106
+ *ProductsManagementApi* | [**products_management_set_product_variant_availability**](docs/ProductsManagementApi.md#products_management_set_product_variant_availability) | **POST** /api/backoffice/v1/products/{id}/set-variant-availability | Set product variants availability. Variants identifiers will be changed.
107
+ *ProductsManagementApi* | [**products_management_set_product_variant_price**](docs/ProductsManagementApi.md#products_management_set_product_variant_price) | **POST** /api/backoffice/v1/products/{id}/set-variant-price | Set product variants price. Variants identifiers will be changed.
108
+ *ProductsManagementApi* | [**products_management_set_product_variant_sku**](docs/ProductsManagementApi.md#products_management_set_product_variant_sku) | **POST** /api/backoffice/v1/products/{id}/set-variant-sku | Set product variants SKU. Variants identifiers will be changed.
109
+ *StorefrontsManagementApi* | [**storefronts_management_create_big_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_big_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/bigcommerce | Creates new BigCommerce storefront.
110
+ *StorefrontsManagementApi* | [**storefronts_management_create_custom_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_custom_storefront) | **POST** /api/backoffice/v1/storefronts/custom | Creates new custom storefront.
111
+ *StorefrontsManagementApi* | [**storefronts_management_create_magento_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_magento_storefront) | **POST** /api/backoffice/v1/storefronts/magento | Creates new Magento storefront.
112
+ *StorefrontsManagementApi* | [**storefronts_management_create_nop_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_nop_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/nopcommerce | Creates new NopCommerce storefront.
113
+ *StorefrontsManagementApi* | [**storefronts_management_create_woo_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_woo_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/woocommerce | Creates new WooCommerce storefront.
114
+ *StorefrontsManagementApi* | [**storefronts_management_delete**](docs/StorefrontsManagementApi.md#storefronts_management_delete) | **DELETE** /api/backoffice/v1/storefronts/{id} | Deletes an existing storefront by its identifier.
115
+ *StorefrontsManagementApi* | [**storefronts_management_get**](docs/StorefrontsManagementApi.md#storefronts_management_get) | **GET** /api/backoffice/v1/storefronts/{id} | Returns a storefront by identifier.
116
+ *StorefrontsManagementApi* | [**storefronts_management_get_all**](docs/StorefrontsManagementApi.md#storefronts_management_get_all) | **GET** /api/backoffice/v1/storefronts | Returns all storefronts, relevant to the specified query parameters.
117
+ *StorefrontsManagementApi* | [**storefronts_management_get_big_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_big_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/bigcommerce/{id} | Returns extended information about BigCommerce storefront.
118
+ *StorefrontsManagementApi* | [**storefronts_management_get_custom_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_custom_storefront) | **GET** /api/backoffice/v1/storefronts/custom/{id} | Returns extended information about custom storefront.
119
+ *StorefrontsManagementApi* | [**storefronts_management_get_magento_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_magento_storefront) | **GET** /api/backoffice/v1/storefronts/magento/{id} | Returns extended information about Magento storefront.
120
+ *StorefrontsManagementApi* | [**storefronts_management_get_nop_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_nop_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/nopcommerce/{id} | Returns extended information about NopCommerce storefront.
121
+ *StorefrontsManagementApi* | [**storefronts_management_get_woo_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_woo_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/woocommerce/{id} | Returns extended information about WooCommerce storefront.
122
+ *UsersManagementApi* | [**users_management_create**](docs/UsersManagementApi.md#users_management_create) | **POST** /api/backoffice/v1/users | Creates a new tenant user.
123
+ *UsersManagementApi* | [**users_management_delete**](docs/UsersManagementApi.md#users_management_delete) | **DELETE** /api/backoffice/v1/users/{id} | Deletes an existing tenant user.
124
+ *UsersManagementApi* | [**users_management_get**](docs/UsersManagementApi.md#users_management_get) | **GET** /api/backoffice/v1/users/{id} | Returns a tenant user by user identifier.
125
+ *UsersManagementApi* | [**users_management_get_all**](docs/UsersManagementApi.md#users_management_get_all) | **GET** /api/backoffice/v1/users | Returns a tenant users list.
126
+ *UsersManagementApi* | [**users_management_get_all_roles**](docs/UsersManagementApi.md#users_management_get_all_roles) | **GET** /api/backoffice/v1/users/roles | Returns all tenant user roles, relevant to the specified query parameters.
127
+
128
+
129
+ ## Documentation For Models
130
+
131
+ - [AppearanceDataDto](docs/AppearanceDataDto.md)
132
+ - [AppearanceDataItemDto](docs/AppearanceDataItemDto.md)
133
+ - [AppearanceDataType](docs/AppearanceDataType.md)
134
+ - [BigCommerceSettingsDto](docs/BigCommerceSettingsDto.md)
135
+ - [BigCommerceStorefrontDto](docs/BigCommerceStorefrontDto.md)
136
+ - [BuildInfoModel](docs/BuildInfoModel.md)
137
+ - [ConflictType](docs/ConflictType.md)
138
+ - [CreateBigCommerceStorefrontDto](docs/CreateBigCommerceStorefrontDto.md)
139
+ - [CreateCustomStorefrontDto](docs/CreateCustomStorefrontDto.md)
140
+ - [CreateMagentoStorefrontDto](docs/CreateMagentoStorefrontDto.md)
141
+ - [CreateNopCommerceStorefrontDto](docs/CreateNopCommerceStorefrontDto.md)
142
+ - [CreateProductDesignConnectionsDto](docs/CreateProductDesignConnectionsDto.md)
143
+ - [CreateProductDocumentConnectionsDto](docs/CreateProductDocumentConnectionsDto.md)
144
+ - [CreateProductDto](docs/CreateProductDto.md)
145
+ - [CreateProductMockupConnectionsDto](docs/CreateProductMockupConnectionsDto.md)
146
+ - [CreateProductOptionDto](docs/CreateProductOptionDto.md)
147
+ - [CreateProductOptionValueDto](docs/CreateProductOptionValueDto.md)
148
+ - [CreateProductReferenceDto](docs/CreateProductReferenceDto.md)
149
+ - [CreateTenantUserDto](docs/CreateTenantUserDto.md)
150
+ - [CreateWooCommerceStorefrontDto](docs/CreateWooCommerceStorefrontDto.md)
151
+ - [CustomStorefrontDto](docs/CustomStorefrontDto.md)
152
+ - [GeneralConflictDto](docs/GeneralConflictDto.md)
153
+ - [ImageInfo](docs/ImageInfo.md)
154
+ - [MagentoSettingsDto](docs/MagentoSettingsDto.md)
155
+ - [MagentoStorefrontDto](docs/MagentoStorefrontDto.md)
156
+ - [MicrosoftAspNetCoreMvcProblemDetails](docs/MicrosoftAspNetCoreMvcProblemDetails.md)
157
+ - [NopCommerceSettingsDto](docs/NopCommerceSettingsDto.md)
158
+ - [NopCommerceStorefrontDto](docs/NopCommerceStorefrontDto.md)
159
+ - [OptionType](docs/OptionType.md)
160
+ - [PagedOfPersonalizationWorkflowDto](docs/PagedOfPersonalizationWorkflowDto.md)
161
+ - [PagedOfProcessingPipelineDto](docs/PagedOfProcessingPipelineDto.md)
162
+ - [PagedOfProductDto](docs/PagedOfProductDto.md)
163
+ - [PagedOfProductOptionDto](docs/PagedOfProductOptionDto.md)
164
+ - [PagedOfProductReferenceDto](docs/PagedOfProductReferenceDto.md)
165
+ - [PagedOfProductVariantDesignDto](docs/PagedOfProductVariantDesignDto.md)
166
+ - [PagedOfProductVariantDocumentDto](docs/PagedOfProductVariantDocumentDto.md)
167
+ - [PagedOfProductVariantDto](docs/PagedOfProductVariantDto.md)
168
+ - [PagedOfProductVariantMockupDto](docs/PagedOfProductVariantMockupDto.md)
169
+ - [PagedOfStorefrontDto](docs/PagedOfStorefrontDto.md)
170
+ - [PagedOfTenantUserDto](docs/PagedOfTenantUserDto.md)
171
+ - [PagedOfTenantUserRoleDto](docs/PagedOfTenantUserRoleDto.md)
172
+ - [PersonalizationWorkflowDto](docs/PersonalizationWorkflowDto.md)
173
+ - [ProcessingPipelineDto](docs/ProcessingPipelineDto.md)
174
+ - [ProductAssetConnectionOptionsDto](docs/ProductAssetConnectionOptionsDto.md)
175
+ - [ProductDesignConnectionDto](docs/ProductDesignConnectionDto.md)
176
+ - [ProductDocumentConnectionDto](docs/ProductDocumentConnectionDto.md)
177
+ - [ProductDto](docs/ProductDto.md)
178
+ - [ProductMockupConnectionDto](docs/ProductMockupConnectionDto.md)
179
+ - [ProductMockupType](docs/ProductMockupType.md)
180
+ - [ProductOptionDto](docs/ProductOptionDto.md)
181
+ - [ProductOptionValueDto](docs/ProductOptionValueDto.md)
182
+ - [ProductReferenceCreationConflictDto](docs/ProductReferenceCreationConflictDto.md)
183
+ - [ProductReferenceDto](docs/ProductReferenceDto.md)
184
+ - [ProductReferenceInfo](docs/ProductReferenceInfo.md)
185
+ - [ProductReferenceType](docs/ProductReferenceType.md)
186
+ - [ProductVariantAvailabilityDto](docs/ProductVariantAvailabilityDto.md)
187
+ - [ProductVariantDesignDto](docs/ProductVariantDesignDto.md)
188
+ - [ProductVariantDocumentDto](docs/ProductVariantDocumentDto.md)
189
+ - [ProductVariantDto](docs/ProductVariantDto.md)
190
+ - [ProductVariantMockupDto](docs/ProductVariantMockupDto.md)
191
+ - [ProductVariantMockupType](docs/ProductVariantMockupType.md)
192
+ - [ProductVariantOptionDto](docs/ProductVariantOptionDto.md)
193
+ - [ProductVariantPriceDto](docs/ProductVariantPriceDto.md)
194
+ - [ProductVariantResourceDto](docs/ProductVariantResourceDto.md)
195
+ - [ProductVariantResourcePreview](docs/ProductVariantResourcePreview.md)
196
+ - [ProductVariantResourceType](docs/ProductVariantResourceType.md)
197
+ - [ProductVariantSkuDto](docs/ProductVariantSkuDto.md)
198
+ - [RemoveProductAssetConnectionDto](docs/RemoveProductAssetConnectionDto.md)
199
+ - [RemoveProductDesignConnectionsDto](docs/RemoveProductDesignConnectionsDto.md)
200
+ - [RemoveProductDocumentConnectionsDto](docs/RemoveProductDocumentConnectionsDto.md)
201
+ - [RemoveProductMockupConnectionsDto](docs/RemoveProductMockupConnectionsDto.md)
202
+ - [SetProductVariantAvailabilityDto](docs/SetProductVariantAvailabilityDto.md)
203
+ - [SetProductVariantPriceDto](docs/SetProductVariantPriceDto.md)
204
+ - [SetProductVariantSkuDto](docs/SetProductVariantSkuDto.md)
205
+ - [SimpleOptionValue](docs/SimpleOptionValue.md)
206
+ - [StorefrontDto](docs/StorefrontDto.md)
207
+ - [StorefrontType](docs/StorefrontType.md)
208
+ - [SurfaceUsageType](docs/SurfaceUsageType.md)
209
+ - [TenantUserDto](docs/TenantUserDto.md)
210
+ - [TenantUserRoleDto](docs/TenantUserRoleDto.md)
211
+ - [WooCommerceSettingsDto](docs/WooCommerceSettingsDto.md)
212
+ - [WooCommerceStorefrontDto](docs/WooCommerceStorefrontDto.md)
213
+ - [WorkflowType](docs/WorkflowType.md)
214
+
215
+
216
+ <a id="documentation-for-authorization"></a>
217
+ ## Documentation For Authorization
218
+
219
+
220
+ Authentication schemes defined for the API:
221
+ <a id="ApiKey"></a>
222
+ ### ApiKey
223
+
224
+ - **Type**: API key
225
+ - **API key parameter name**: X-API-Key
226
+ - **Location**: HTTP header
227
+
228
+ <a id="Bearer"></a>
229
+ ### Bearer
230
+
231
+ - **Type**: API key
232
+ - **API key parameter name**: Authorization
233
+ - **Location**: HTTP header
234
+
235
+ <a id="OAuth2ClientCredentials"></a>
236
+ ### OAuth2ClientCredentials
237
+
238
+ - **Type**: OAuth
239
+ - **Flow**: application
240
+ - **Authorization URL**:
241
+ - **Scopes**: N/A
242
+
243
+ <a id="OAuth2Implicit"></a>
244
+ ### OAuth2Implicit
245
+
246
+ - **Type**: OAuth
247
+ - **Flow**: implicit
248
+ - **Authorization URL**: https://customerscanvashub.com/connect/authorize
249
+ - **Scopes**:
250
+ - **Projects_full**: Manipulate projects
251
+ - **Projects_read**: Read projects
252
+ - **Templates_full**: Manipulate products
253
+ - **Templates_read**: Read products
254
+ - **Storefronts_full**: Manipulate products
255
+ - **Storefronts_read**: Read products
256
+ - **StorefrontUsers_full**: Manipulate storefront users
257
+ - **StorefrontUsers_read**: Read storefront users
258
+ - **TenantUsers_full**: Manipulate storefront users
259
+ - **TenantUsers_read**: Read storefront users
260
+
261
+ <a id="oauth2-code"></a>
262
+ ### oauth2-code
263
+
264
+ - **Type**: OAuth
265
+ - **Flow**: accessCode
266
+ - **Authorization URL**: https://customerscanvashub.com/connect/authorize
267
+ - **Scopes**:
268
+ - **Projects_full**: Manipulate projects
269
+ - **Projects_read**: Read projects
270
+ - **Templates_full**: Manipulate products
271
+ - **Templates_read**: Read products
272
+ - **Storefronts_full**: Manipulate products
273
+ - **Storefronts_read**: Read products
274
+ - **StorefrontUsers_full**: Manipulate storefront users
275
+ - **StorefrontUsers_read**: Read storefront users
276
+ - **TenantUsers_full**: Manipulate storefront users
277
+ - **TenantUsers_read**: Read storefront users
278
+
279
+
280
+
281
+
282
+
aurigma_backoffice_api_client-1.0.0/README.md ADDED
@@ -0,0 +1,271 @@
1
+ # aurigma-backoffice-api-client
2
+
3
+ Python client library for [Aurigma BackOffice API](https://customerscanvas.com/dev/backoffice/api/backoffice/overview.html).
4
+
5
+ ## Requirements.
6
+
7
+ - Python 3.9+
8
+ - Dependencies:
9
+ - python-dateutil>=2.8.2
10
+ - httpx>=0.28.1
11
+ - pydantic>=2
12
+ - typing-extensions>=4.7.1
13
+
14
+ ## Installation & Usage
15
+ ### pip install
16
+
17
+ ```sh
18
+ pip install aurigma-backoffice-api-client
19
+ ```
20
+
21
+ Then import the package:
22
+ ```python
23
+ import aurigma.backoffice
24
+ ```
25
+
26
+ ## Getting Started
27
+
28
+ Please follow the [installation procedure](#installation--usage) and then run the following:
29
+
30
+ ```python
31
+
32
+ import aurigma.backoffice
33
+ from aurigma.backoffice.rest import ApiException
34
+ from pprint import pprint
35
+
36
+ # See configuration.py for a list of all supported configuration parameters.
37
+ configuration = aurigma.storefront.Configuration(
38
+ host = "http://api.customerscanvashub.com/"
39
+ )
40
+
41
+
42
+
43
+
44
+ # Enter a context with an instance of the API client
45
+ async with aurigma.backoffice.ApiClient(configuration) as api_client:
46
+ # Create an instance of the API class
47
+ api_instance = aurigma.backoffice.BuildInfoApi(api_client)
48
+
49
+ try:
50
+ # Returns assembly build info.
51
+ api_response = await api_instance.build_info_get_info()
52
+ print("The response of BuildInfoApi->build_info_get_info:\n")
53
+ pprint(api_response)
54
+ except ApiException as e:
55
+ print("Exception when calling BuildInfoApi->build_info_get_info: %s\n" % e)
56
+
57
+ ```
58
+
59
+ ## Documentation for API Endpoints
60
+
61
+ Depending on the geographical location of your Customer's Canvas Hub instance, the API gateway address may vary:
62
+
63
+ https://api.customerscanvashub.com/ - United States instance
64
+ https://api.eu.customerscanvashub.com/ - European instance
65
+ https://api.au.customerscanvashub.com/ - Australian instance
66
+
67
+ Class | Method | HTTP request | Description
68
+ ------------ | ------------- | ------------- | -------------
69
+ *BuildInfoApi* | [**build_info_get_info**](docs/BuildInfoApi.md#build_info_get_info) | **GET** /api/backoffice/v1/info | Returns assembly build info.
70
+ *BuildInfoApi* | [**build_info_head_info**](docs/BuildInfoApi.md#build_info_head_info) | **HEAD** /api/backoffice/v1/info | Returns assembly build info.
71
+ *ProductReferencesManagementApi* | [**product_references_management_create**](docs/ProductReferencesManagementApi.md#product_references_management_create) | **POST** /api/backoffice/v1/product-references | Creates a new storefront product reference.
72
+ *ProductReferencesManagementApi* | [**product_references_management_delete**](docs/ProductReferencesManagementApi.md#product_references_management_delete) | **DELETE** /api/backoffice/v1/product-references/{reference} | Deletes the storefront product reference.
73
+ *ProductReferencesManagementApi* | [**product_references_management_get**](docs/ProductReferencesManagementApi.md#product_references_management_get) | **GET** /api/backoffice/v1/product-references/{reference} | Returns a storefront product reference.
74
+ *ProductReferencesManagementApi* | [**product_references_management_get_all**](docs/ProductReferencesManagementApi.md#product_references_management_get_all) | **GET** /api/backoffice/v1/product-references | Returns all storefront product references relevant to the specified query parameters.
75
+ *ProductsManagementApi* | [**products_management_create_designs_connections**](docs/ProductsManagementApi.md#products_management_create_designs_connections) | **POST** /api/backoffice/v1/products/{id}/design-connections | Creates new designs connections for a specified product.
76
+ *ProductsManagementApi* | [**products_management_create_documents_connections**](docs/ProductsManagementApi.md#products_management_create_documents_connections) | **POST** /api/backoffice/v1/products/{id}/document-connections | Creates new documents connections for a specified product.
77
+ *ProductsManagementApi* | [**products_management_create_mockups_connections**](docs/ProductsManagementApi.md#products_management_create_mockups_connections) | **POST** /api/backoffice/v1/products/{id}/mockup-connections | Creates new mockups connections for a specified product.
78
+ *ProductsManagementApi* | [**products_management_create_product**](docs/ProductsManagementApi.md#products_management_create_product) | **POST** /api/backoffice/v1/products | Creates a new product and returns its description.
79
+ *ProductsManagementApi* | [**products_management_delete_product**](docs/ProductsManagementApi.md#products_management_delete_product) | **DELETE** /api/backoffice/v1/products/{id} | Deletes a product by its identifier.
80
+ *ProductsManagementApi* | [**products_management_get_all_products**](docs/ProductsManagementApi.md#products_management_get_all_products) | **GET** /api/backoffice/v1/products | Returns all products, relevant to the specified query parameters.
81
+ *ProductsManagementApi* | [**products_management_get_available_personalization_workflows**](docs/ProductsManagementApi.md#products_management_get_available_personalization_workflows) | **GET** /api/backoffice/v1/products/available-workflows | Returns all available product personalization workflows.
82
+ *ProductsManagementApi* | [**products_management_get_available_processing_pipelines**](docs/ProductsManagementApi.md#products_management_get_available_processing_pipelines) | **GET** /api/backoffice/v1/products/available-pipelines | Returns all available product processing pipelines.
83
+ *ProductsManagementApi* | [**products_management_get_product**](docs/ProductsManagementApi.md#products_management_get_product) | **GET** /api/backoffice/v1/products/{id} | Returns a product by its identifier.
84
+ *ProductsManagementApi* | [**products_management_get_product_options**](docs/ProductsManagementApi.md#products_management_get_product_options) | **GET** /api/backoffice/v1/products/{id}/options | Returns a list of product options.
85
+ *ProductsManagementApi* | [**products_management_get_product_variant**](docs/ProductsManagementApi.md#products_management_get_product_variant) | **GET** /api/backoffice/v1/products/{id}/variants/{productVariantId} | Returns a product variant.
86
+ *ProductsManagementApi* | [**products_management_get_product_variant_designs**](docs/ProductsManagementApi.md#products_management_get_product_variant_designs) | **GET** /api/backoffice/v1/products/{id}/variant-designs | Returns a list of product variant designs.
87
+ *ProductsManagementApi* | [**products_management_get_product_variant_documents**](docs/ProductsManagementApi.md#products_management_get_product_variant_documents) | **GET** /api/backoffice/v1/products/{id}/variant-documents | Returns a list of product variant documents.
88
+ *ProductsManagementApi* | [**products_management_get_product_variant_mockups**](docs/ProductsManagementApi.md#products_management_get_product_variant_mockups) | **GET** /api/backoffice/v1/products/{id}/variant-mockups | Returns a list of product variant mockups.
89
+ *ProductsManagementApi* | [**products_management_get_product_variants**](docs/ProductsManagementApi.md#products_management_get_product_variants) | **GET** /api/backoffice/v1/products/{id}/variants | Returns a list of product variants.
90
+ *ProductsManagementApi* | [**products_management_import_products**](docs/ProductsManagementApi.md#products_management_import_products) | **POST** /api/backoffice/v1/products/import | Imports products from a specific CSV file and returns a list of imported products descriptions.
91
+ *ProductsManagementApi* | [**products_management_remove_designs_connections**](docs/ProductsManagementApi.md#products_management_remove_designs_connections) | **DELETE** /api/backoffice/v1/products/{id}/design-connections | Removes designs connections for a specified product.
92
+ *ProductsManagementApi* | [**products_management_remove_documents_connections**](docs/ProductsManagementApi.md#products_management_remove_documents_connections) | **DELETE** /api/backoffice/v1/products/{id}/document-connections | Removes documents connections for a specified product.
93
+ *ProductsManagementApi* | [**products_management_remove_mockups_connections**](docs/ProductsManagementApi.md#products_management_remove_mockups_connections) | **DELETE** /api/backoffice/v1/products/{id}/mockup-connections | Removes mockups connections for a specified product.
94
+ *ProductsManagementApi* | [**products_management_set_product_image**](docs/ProductsManagementApi.md#products_management_set_product_image) | **POST** /api/backoffice/v1/products/{id}/set-image | Set a thumbnail image for an existing product.
95
+ *ProductsManagementApi* | [**products_management_set_product_variant_availability**](docs/ProductsManagementApi.md#products_management_set_product_variant_availability) | **POST** /api/backoffice/v1/products/{id}/set-variant-availability | Set product variants availability. Variants identifiers will be changed.
96
+ *ProductsManagementApi* | [**products_management_set_product_variant_price**](docs/ProductsManagementApi.md#products_management_set_product_variant_price) | **POST** /api/backoffice/v1/products/{id}/set-variant-price | Set product variants price. Variants identifiers will be changed.
97
+ *ProductsManagementApi* | [**products_management_set_product_variant_sku**](docs/ProductsManagementApi.md#products_management_set_product_variant_sku) | **POST** /api/backoffice/v1/products/{id}/set-variant-sku | Set product variants SKU. Variants identifiers will be changed.
98
+ *StorefrontsManagementApi* | [**storefronts_management_create_big_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_big_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/bigcommerce | Creates new BigCommerce storefront.
99
+ *StorefrontsManagementApi* | [**storefronts_management_create_custom_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_custom_storefront) | **POST** /api/backoffice/v1/storefronts/custom | Creates new custom storefront.
100
+ *StorefrontsManagementApi* | [**storefronts_management_create_magento_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_magento_storefront) | **POST** /api/backoffice/v1/storefronts/magento | Creates new Magento storefront.
101
+ *StorefrontsManagementApi* | [**storefronts_management_create_nop_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_nop_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/nopcommerce | Creates new NopCommerce storefront.
102
+ *StorefrontsManagementApi* | [**storefronts_management_create_woo_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_create_woo_commerce_storefront) | **POST** /api/backoffice/v1/storefronts/woocommerce | Creates new WooCommerce storefront.
103
+ *StorefrontsManagementApi* | [**storefronts_management_delete**](docs/StorefrontsManagementApi.md#storefronts_management_delete) | **DELETE** /api/backoffice/v1/storefronts/{id} | Deletes an existing storefront by its identifier.
104
+ *StorefrontsManagementApi* | [**storefronts_management_get**](docs/StorefrontsManagementApi.md#storefronts_management_get) | **GET** /api/backoffice/v1/storefronts/{id} | Returns a storefront by identifier.
105
+ *StorefrontsManagementApi* | [**storefronts_management_get_all**](docs/StorefrontsManagementApi.md#storefronts_management_get_all) | **GET** /api/backoffice/v1/storefronts | Returns all storefronts, relevant to the specified query parameters.
106
+ *StorefrontsManagementApi* | [**storefronts_management_get_big_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_big_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/bigcommerce/{id} | Returns extended information about BigCommerce storefront.
107
+ *StorefrontsManagementApi* | [**storefronts_management_get_custom_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_custom_storefront) | **GET** /api/backoffice/v1/storefronts/custom/{id} | Returns extended information about custom storefront.
108
+ *StorefrontsManagementApi* | [**storefronts_management_get_magento_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_magento_storefront) | **GET** /api/backoffice/v1/storefronts/magento/{id} | Returns extended information about Magento storefront.
109
+ *StorefrontsManagementApi* | [**storefronts_management_get_nop_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_nop_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/nopcommerce/{id} | Returns extended information about NopCommerce storefront.
110
+ *StorefrontsManagementApi* | [**storefronts_management_get_woo_commerce_storefront**](docs/StorefrontsManagementApi.md#storefronts_management_get_woo_commerce_storefront) | **GET** /api/backoffice/v1/storefronts/woocommerce/{id} | Returns extended information about WooCommerce storefront.
111
+ *UsersManagementApi* | [**users_management_create**](docs/UsersManagementApi.md#users_management_create) | **POST** /api/backoffice/v1/users | Creates a new tenant user.
112
+ *UsersManagementApi* | [**users_management_delete**](docs/UsersManagementApi.md#users_management_delete) | **DELETE** /api/backoffice/v1/users/{id} | Deletes an existing tenant user.
113
+ *UsersManagementApi* | [**users_management_get**](docs/UsersManagementApi.md#users_management_get) | **GET** /api/backoffice/v1/users/{id} | Returns a tenant user by user identifier.
114
+ *UsersManagementApi* | [**users_management_get_all**](docs/UsersManagementApi.md#users_management_get_all) | **GET** /api/backoffice/v1/users | Returns a tenant users list.
115
+ *UsersManagementApi* | [**users_management_get_all_roles**](docs/UsersManagementApi.md#users_management_get_all_roles) | **GET** /api/backoffice/v1/users/roles | Returns all tenant user roles, relevant to the specified query parameters.
116
+
117
+
118
+ ## Documentation For Models
119
+
120
+ - [AppearanceDataDto](docs/AppearanceDataDto.md)
121
+ - [AppearanceDataItemDto](docs/AppearanceDataItemDto.md)
122
+ - [AppearanceDataType](docs/AppearanceDataType.md)
123
+ - [BigCommerceSettingsDto](docs/BigCommerceSettingsDto.md)
124
+ - [BigCommerceStorefrontDto](docs/BigCommerceStorefrontDto.md)
125
+ - [BuildInfoModel](docs/BuildInfoModel.md)
126
+ - [ConflictType](docs/ConflictType.md)
127
+ - [CreateBigCommerceStorefrontDto](docs/CreateBigCommerceStorefrontDto.md)
128
+ - [CreateCustomStorefrontDto](docs/CreateCustomStorefrontDto.md)
129
+ - [CreateMagentoStorefrontDto](docs/CreateMagentoStorefrontDto.md)
130
+ - [CreateNopCommerceStorefrontDto](docs/CreateNopCommerceStorefrontDto.md)
131
+ - [CreateProductDesignConnectionsDto](docs/CreateProductDesignConnectionsDto.md)
132
+ - [CreateProductDocumentConnectionsDto](docs/CreateProductDocumentConnectionsDto.md)
133
+ - [CreateProductDto](docs/CreateProductDto.md)
134
+ - [CreateProductMockupConnectionsDto](docs/CreateProductMockupConnectionsDto.md)
135
+ - [CreateProductOptionDto](docs/CreateProductOptionDto.md)
136
+ - [CreateProductOptionValueDto](docs/CreateProductOptionValueDto.md)
137
+ - [CreateProductReferenceDto](docs/CreateProductReferenceDto.md)
138
+ - [CreateTenantUserDto](docs/CreateTenantUserDto.md)
139
+ - [CreateWooCommerceStorefrontDto](docs/CreateWooCommerceStorefrontDto.md)
140
+ - [CustomStorefrontDto](docs/CustomStorefrontDto.md)
141
+ - [GeneralConflictDto](docs/GeneralConflictDto.md)
142
+ - [ImageInfo](docs/ImageInfo.md)
143
+ - [MagentoSettingsDto](docs/MagentoSettingsDto.md)
144
+ - [MagentoStorefrontDto](docs/MagentoStorefrontDto.md)
145
+ - [MicrosoftAspNetCoreMvcProblemDetails](docs/MicrosoftAspNetCoreMvcProblemDetails.md)
146
+ - [NopCommerceSettingsDto](docs/NopCommerceSettingsDto.md)
147
+ - [NopCommerceStorefrontDto](docs/NopCommerceStorefrontDto.md)
148
+ - [OptionType](docs/OptionType.md)
149
+ - [PagedOfPersonalizationWorkflowDto](docs/PagedOfPersonalizationWorkflowDto.md)
150
+ - [PagedOfProcessingPipelineDto](docs/PagedOfProcessingPipelineDto.md)
151
+ - [PagedOfProductDto](docs/PagedOfProductDto.md)
152
+ - [PagedOfProductOptionDto](docs/PagedOfProductOptionDto.md)
153
+ - [PagedOfProductReferenceDto](docs/PagedOfProductReferenceDto.md)
154
+ - [PagedOfProductVariantDesignDto](docs/PagedOfProductVariantDesignDto.md)
155
+ - [PagedOfProductVariantDocumentDto](docs/PagedOfProductVariantDocumentDto.md)
156
+ - [PagedOfProductVariantDto](docs/PagedOfProductVariantDto.md)
157
+ - [PagedOfProductVariantMockupDto](docs/PagedOfProductVariantMockupDto.md)
158
+ - [PagedOfStorefrontDto](docs/PagedOfStorefrontDto.md)
159
+ - [PagedOfTenantUserDto](docs/PagedOfTenantUserDto.md)
160
+ - [PagedOfTenantUserRoleDto](docs/PagedOfTenantUserRoleDto.md)
161
+ - [PersonalizationWorkflowDto](docs/PersonalizationWorkflowDto.md)
162
+ - [ProcessingPipelineDto](docs/ProcessingPipelineDto.md)
163
+ - [ProductAssetConnectionOptionsDto](docs/ProductAssetConnectionOptionsDto.md)
164
+ - [ProductDesignConnectionDto](docs/ProductDesignConnectionDto.md)
165
+ - [ProductDocumentConnectionDto](docs/ProductDocumentConnectionDto.md)
166
+ - [ProductDto](docs/ProductDto.md)
167
+ - [ProductMockupConnectionDto](docs/ProductMockupConnectionDto.md)
168
+ - [ProductMockupType](docs/ProductMockupType.md)
169
+ - [ProductOptionDto](docs/ProductOptionDto.md)
170
+ - [ProductOptionValueDto](docs/ProductOptionValueDto.md)
171
+ - [ProductReferenceCreationConflictDto](docs/ProductReferenceCreationConflictDto.md)
172
+ - [ProductReferenceDto](docs/ProductReferenceDto.md)
173
+ - [ProductReferenceInfo](docs/ProductReferenceInfo.md)
174
+ - [ProductReferenceType](docs/ProductReferenceType.md)
175
+ - [ProductVariantAvailabilityDto](docs/ProductVariantAvailabilityDto.md)
176
+ - [ProductVariantDesignDto](docs/ProductVariantDesignDto.md)
177
+ - [ProductVariantDocumentDto](docs/ProductVariantDocumentDto.md)
178
+ - [ProductVariantDto](docs/ProductVariantDto.md)
179
+ - [ProductVariantMockupDto](docs/ProductVariantMockupDto.md)
180
+ - [ProductVariantMockupType](docs/ProductVariantMockupType.md)
181
+ - [ProductVariantOptionDto](docs/ProductVariantOptionDto.md)
182
+ - [ProductVariantPriceDto](docs/ProductVariantPriceDto.md)
183
+ - [ProductVariantResourceDto](docs/ProductVariantResourceDto.md)
184
+ - [ProductVariantResourcePreview](docs/ProductVariantResourcePreview.md)
185
+ - [ProductVariantResourceType](docs/ProductVariantResourceType.md)
186
+ - [ProductVariantSkuDto](docs/ProductVariantSkuDto.md)
187
+ - [RemoveProductAssetConnectionDto](docs/RemoveProductAssetConnectionDto.md)
188
+ - [RemoveProductDesignConnectionsDto](docs/RemoveProductDesignConnectionsDto.md)
189
+ - [RemoveProductDocumentConnectionsDto](docs/RemoveProductDocumentConnectionsDto.md)
190
+ - [RemoveProductMockupConnectionsDto](docs/RemoveProductMockupConnectionsDto.md)
191
+ - [SetProductVariantAvailabilityDto](docs/SetProductVariantAvailabilityDto.md)
192
+ - [SetProductVariantPriceDto](docs/SetProductVariantPriceDto.md)
193
+ - [SetProductVariantSkuDto](docs/SetProductVariantSkuDto.md)
194
+ - [SimpleOptionValue](docs/SimpleOptionValue.md)
195
+ - [StorefrontDto](docs/StorefrontDto.md)
196
+ - [StorefrontType](docs/StorefrontType.md)
197
+ - [SurfaceUsageType](docs/SurfaceUsageType.md)
198
+ - [TenantUserDto](docs/TenantUserDto.md)
199
+ - [TenantUserRoleDto](docs/TenantUserRoleDto.md)
200
+ - [WooCommerceSettingsDto](docs/WooCommerceSettingsDto.md)
201
+ - [WooCommerceStorefrontDto](docs/WooCommerceStorefrontDto.md)
202
+ - [WorkflowType](docs/WorkflowType.md)
203
+
204
+
205
+ <a id="documentation-for-authorization"></a>
206
+ ## Documentation For Authorization
207
+
208
+
209
+ Authentication schemes defined for the API:
210
+ <a id="ApiKey"></a>
211
+ ### ApiKey
212
+
213
+ - **Type**: API key
214
+ - **API key parameter name**: X-API-Key
215
+ - **Location**: HTTP header
216
+
217
+ <a id="Bearer"></a>
218
+ ### Bearer
219
+
220
+ - **Type**: API key
221
+ - **API key parameter name**: Authorization
222
+ - **Location**: HTTP header
223
+
224
+ <a id="OAuth2ClientCredentials"></a>
225
+ ### OAuth2ClientCredentials
226
+
227
+ - **Type**: OAuth
228
+ - **Flow**: application
229
+ - **Authorization URL**:
230
+ - **Scopes**: N/A
231
+
232
+ <a id="OAuth2Implicit"></a>
233
+ ### OAuth2Implicit
234
+
235
+ - **Type**: OAuth
236
+ - **Flow**: implicit
237
+ - **Authorization URL**: https://customerscanvashub.com/connect/authorize
238
+ - **Scopes**:
239
+ - **Projects_full**: Manipulate projects
240
+ - **Projects_read**: Read projects
241
+ - **Templates_full**: Manipulate products
242
+ - **Templates_read**: Read products
243
+ - **Storefronts_full**: Manipulate products
244
+ - **Storefronts_read**: Read products
245
+ - **StorefrontUsers_full**: Manipulate storefront users
246
+ - **StorefrontUsers_read**: Read storefront users
247
+ - **TenantUsers_full**: Manipulate storefront users
248
+ - **TenantUsers_read**: Read storefront users
249
+
250
+ <a id="oauth2-code"></a>
251
+ ### oauth2-code
252
+
253
+ - **Type**: OAuth
254
+ - **Flow**: accessCode
255
+ - **Authorization URL**: https://customerscanvashub.com/connect/authorize
256
+ - **Scopes**:
257
+ - **Projects_full**: Manipulate projects
258
+ - **Projects_read**: Read projects
259
+ - **Templates_full**: Manipulate products
260
+ - **Templates_read**: Read products
261
+ - **Storefronts_full**: Manipulate products
262
+ - **Storefronts_read**: Read products
263
+ - **StorefrontUsers_full**: Manipulate storefront users
264
+ - **StorefrontUsers_read**: Read storefront users
265
+ - **TenantUsers_full**: Manipulate storefront users
266
+ - **TenantUsers_read**: Read storefront users
267
+
268
+
269
+
270
+
271
+
aurigma_backoffice_api_client-1.0.0/pyproject.toml ADDED
@@ -0,0 +1,23 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "aurigma-backoffice-api-client"
7
+ version = "1.0.0"
8
+ description = "Aurigma BackOffice API client"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ dependencies = [
12
+ "python-dateutil>=2.8.2",
13
+ "httpx>=0.28.1",
14
+ "pydantic>=2,<3",
15
+ "typing-extensions>=4.7.1; python_version < '3.11'",
16
+ ]
17
+
18
+ [tool.setuptools]
19
+ package-dir = {"" = "src"}
20
+
21
+ [tool.setuptools.packages.find]
22
+ where = ["src"]
23
+ include = ["aurigma.backoffice*"]
aurigma_backoffice_api_client-1.0.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+