@erp-galoper/types 1.0.1240 → 1.0.1242

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 (2) hide show
  1. package/openapi.ts +486 -32
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -20142,10 +20142,15 @@ export interface paths {
20142
20142
  get: operations["integration_sync_views_get_sync_store"];
20143
20143
  /**
20144
20144
  * Update Sync Store
20145
- * @description Endpoint for updating sync store configuration
20145
+ * @description Endpoint for updating sync store configuration (Shopify or WooCommerce)
20146
+ *
20147
+ * Can update platform-specific fields:
20148
+ * - Shopify: storeDomain, accessToken, apiVersion
20149
+ * - WooCommerce: storeUrl, consumerKey, consumerSecret, apiVersion
20150
+ *
20146
20151
  * Possible Responses:
20147
20152
  * - 200: syncStoreUpdated
20148
- * - 400: validationFailed, onlineStoreSettingNotConfigured
20153
+ * - 400: validationFailed, onlineStoreSettingNotConfigured, connectionFailed
20149
20154
  * - 404: storeDoesNotExist
20150
20155
  * - 403: permissionDenied
20151
20156
  * - 500: unexpectedError
@@ -20155,10 +20160,15 @@ export interface paths {
20155
20160
  put: operations["integration_sync_views_update_sync_store"];
20156
20161
  /**
20157
20162
  * Create Sync Store
20158
- * @description Endpoint for creating a sync store configuration
20163
+ * @description Endpoint for creating a sync store configuration (Shopify or WooCommerce)
20164
+ *
20165
+ * Required fields by platform:
20166
+ * - Shopify: storeName, storeType='shopify', storeDomain, accessToken, apiVersion (optional, default: '2024-01')
20167
+ * - WooCommerce: storeName, storeType='woocommerce', storeUrl, consumerKey, consumerSecret, apiVersion (optional, default: 'wc/v3')
20168
+ *
20159
20169
  * Possible Responses:
20160
20170
  * - 201: syncStoreCreated
20161
- * - 400: storeAlreadyExists, validationFailed, onlineStoreSettingNotConfigured
20171
+ * - 400: storeAlreadyExists, validationFailed, onlineStoreSettingNotConfigured, connectionFailed
20162
20172
  * - 403: permissionDenied
20163
20173
  * - 500: unexpectedError
20164
20174
  *
@@ -20182,9 +20192,13 @@ export interface paths {
20182
20192
  put?: never;
20183
20193
  /**
20184
20194
  * Test Sync Store Connection
20185
- * @description Endpoint for testing sync store connection
20195
+ * @description Endpoint for testing sync store connection (Shopify or WooCommerce)
20196
+ *
20197
+ * Tests the API connection to the configured store and updates connection status.
20198
+ *
20186
20199
  * Possible Responses:
20187
- * - 200: success: true/false
20200
+ * - 200: success: true (connection successful)
20201
+ * - 400: connectionFailed (connection test failed)
20188
20202
  * - 404: storeDoesNotExist
20189
20203
  * - 403: permissionDenied
20190
20204
  * - 500: unexpectedError
@@ -20239,6 +20253,126 @@ export interface paths {
20239
20253
  patch?: never;
20240
20254
  trace?: never;
20241
20255
  };
20256
+ "/api/v1/integrations/sync/sync-single-category/{id}/": {
20257
+ parameters: {
20258
+ query?: never;
20259
+ header?: never;
20260
+ path?: never;
20261
+ cookie?: never;
20262
+ };
20263
+ get?: never;
20264
+ put?: never;
20265
+ /**
20266
+ * Manually sync a single category to WooCommerce
20267
+ * @description Triggers background sync of a specific ERP category to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Categories are synced one-way from ERP to WooCommerce, including parent category hierarchy.
20268
+ */
20269
+ post: operations["integration_sync_views_sync_single_category_endpoint"];
20270
+ delete?: never;
20271
+ options?: never;
20272
+ head?: never;
20273
+ patch?: never;
20274
+ trace?: never;
20275
+ };
20276
+ "/api/v1/integrations/sync/sync-all-categories/": {
20277
+ parameters: {
20278
+ query?: never;
20279
+ header?: never;
20280
+ path?: never;
20281
+ cookie?: never;
20282
+ };
20283
+ get?: never;
20284
+ put?: never;
20285
+ /**
20286
+ * Manually sync all categories to WooCommerce
20287
+ * @description Triggers background sync of all ERP categories to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Categories are synced one-way from ERP to WooCommerce, including parent category hierarchy.
20288
+ */
20289
+ post: operations["integration_sync_views_sync_all_categories_endpoint"];
20290
+ delete?: never;
20291
+ options?: never;
20292
+ head?: never;
20293
+ patch?: never;
20294
+ trace?: never;
20295
+ };
20296
+ "/api/v1/integrations/sync/sync-single-brand/{id}/": {
20297
+ parameters: {
20298
+ query?: never;
20299
+ header?: never;
20300
+ path?: never;
20301
+ cookie?: never;
20302
+ };
20303
+ get?: never;
20304
+ put?: never;
20305
+ /**
20306
+ * Manually sync a single brand to WooCommerce
20307
+ * @description Triggers background sync of a specific ERP brand to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Brands are synced one-way from ERP to WooCommerce as product attributes.
20308
+ */
20309
+ post: operations["integration_sync_views_sync_single_brand_endpoint"];
20310
+ delete?: never;
20311
+ options?: never;
20312
+ head?: never;
20313
+ patch?: never;
20314
+ trace?: never;
20315
+ };
20316
+ "/api/v1/integrations/sync/sync-all-brands/": {
20317
+ parameters: {
20318
+ query?: never;
20319
+ header?: never;
20320
+ path?: never;
20321
+ cookie?: never;
20322
+ };
20323
+ get?: never;
20324
+ put?: never;
20325
+ /**
20326
+ * Manually sync all brands to WooCommerce
20327
+ * @description Triggers background sync of all ERP brands to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Brands are synced one-way from ERP to WooCommerce as product attributes.
20328
+ */
20329
+ post: operations["integration_sync_views_sync_all_brands_endpoint"];
20330
+ delete?: never;
20331
+ options?: never;
20332
+ head?: never;
20333
+ patch?: never;
20334
+ trace?: never;
20335
+ };
20336
+ "/api/v1/integrations/sync/sync-single-tag/{id}/": {
20337
+ parameters: {
20338
+ query?: never;
20339
+ header?: never;
20340
+ path?: never;
20341
+ cookie?: never;
20342
+ };
20343
+ get?: never;
20344
+ put?: never;
20345
+ /**
20346
+ * Manually sync a single tag to WooCommerce
20347
+ * @description Triggers background sync of a specific ERP tag to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Tags are synced one-way from ERP to WooCommerce.
20348
+ */
20349
+ post: operations["integration_sync_views_sync_single_tag_endpoint"];
20350
+ delete?: never;
20351
+ options?: never;
20352
+ head?: never;
20353
+ patch?: never;
20354
+ trace?: never;
20355
+ };
20356
+ "/api/v1/integrations/sync/sync-all-tags/": {
20357
+ parameters: {
20358
+ query?: never;
20359
+ header?: never;
20360
+ path?: never;
20361
+ cookie?: never;
20362
+ };
20363
+ get?: never;
20364
+ put?: never;
20365
+ /**
20366
+ * Manually sync all tags to WooCommerce
20367
+ * @description Triggers background sync of all ERP tags to WooCommerce. **Note: This endpoint only works for WooCommerce stores.** Tags are synced one-way from ERP to WooCommerce.
20368
+ */
20369
+ post: operations["integration_sync_views_sync_all_tags_endpoint"];
20370
+ delete?: never;
20371
+ options?: never;
20372
+ head?: never;
20373
+ patch?: never;
20374
+ trace?: never;
20375
+ };
20242
20376
  "/api/v1/integrations/sync/orders/sync/": {
20243
20377
  parameters: {
20244
20378
  query?: never;
@@ -52807,12 +52941,15 @@ export interface components {
52807
52941
  };
52808
52942
  /**
52809
52943
  * StoreType
52810
- * @constant
52944
+ * @enum {string}
52811
52945
  */
52812
- StoreType: "shopify";
52946
+ StoreType: "shopify" | "wooCommerce";
52813
52947
  /**
52814
52948
  * SyncStoreSchema
52815
52949
  * @description Schema for sync store response
52950
+ *
52951
+ * Both platforms use the same fields with different interpretations.
52952
+ * Check storeType to understand field meanings.
52816
52953
  */
52817
52954
  SyncStoreSchema: {
52818
52955
  /**
@@ -52829,29 +52966,61 @@ export interface components {
52829
52966
  * Format: uuid
52830
52967
  */
52831
52968
  id: string;
52832
- /** Storename */
52969
+ /**
52970
+ * Storename
52971
+ * @description Human-readable store name
52972
+ */
52833
52973
  storeName: string;
52974
+ /** @description Platform type: 'shopify' or 'wooCommerce' */
52834
52975
  storeType: components["schemas"]["StoreType"];
52835
- /** Storedomain */
52836
- storeDomain: string;
52837
- /** Storeurl */
52838
- storeUrl: string;
52839
- /** Apiversion */
52840
- apiVersion: string;
52841
- /** Isconnected */
52976
+ /**
52977
+ * Storedomain
52978
+ * @description Store domain - For Shopify: mystore.myshopify.com, For WooCommerce: mystore.com
52979
+ */
52980
+ storeDomain?: string | null;
52981
+ /**
52982
+ * Storeurl
52983
+ * @description Computed full store URL (https://storeDomain)
52984
+ */
52985
+ storeUrl?: string | null;
52986
+ /**
52987
+ * Apiversion
52988
+ * @description API version - Shopify: '2024-01', WooCommerce: 'wc/v3'
52989
+ */
52990
+ apiVersion?: string | null;
52991
+ /**
52992
+ * Isconnected
52993
+ * @description Whether store connection was successful
52994
+ */
52842
52995
  isConnected: boolean;
52843
- /** Lastconnectiontest */
52996
+ /**
52997
+ * Lastconnectiontest
52998
+ * @description Timestamp of last connection test
52999
+ */
52844
53000
  lastConnectionTest?: string | null;
52845
- /** Connectionerror */
53001
+ /**
53002
+ * Connectionerror
53003
+ * @description Last connection error message if any
53004
+ */
52846
53005
  connectionError?: string | null;
52847
- /** Status */
53006
+ /**
53007
+ * Status
53008
+ * @description Sync status: 'active', 'paused', 'error', or 'disabled'
53009
+ */
52848
53010
  status: string;
52849
- /** Lastproductssync */
53011
+ /**
53012
+ * Lastproductssync
53013
+ * @description Timestamp of last successful product sync
53014
+ */
52850
53015
  lastProductsSync?: string | null;
52851
- /** Lastorderssync */
53016
+ /**
53017
+ * Lastorderssync
53018
+ * @description Timestamp of last successful order sync
53019
+ */
52852
53020
  lastOrdersSync?: string | null;
52853
53021
  /**
52854
53022
  * Canupdate
53023
+ * @description Whether user has permission to update this store
52855
53024
  * @default false
52856
53025
  */
52857
53026
  canUpdate: boolean;
@@ -52859,6 +53028,19 @@ export interface components {
52859
53028
  /**
52860
53029
  * SyncStoreCreateSchema
52861
53030
  * @description Schema for creating a sync store
53031
+ *
53032
+ * Required fields vary by store type:
53033
+ *
53034
+ * For Shopify:
53035
+ * - storeDomain: Store domain (e.g., mystore.myshopify.com)
53036
+ * - accessToken: Shopify API access token
53037
+ * - apiVersion: Shopify API version (default: 2024-01)
53038
+ *
53039
+ * For WooCommerce:
53040
+ * - storeDomain: Store domain (e.g., mystore.com)
53041
+ * - accessToken: WooCommerce consumer key
53042
+ * - consumerSecret: WooCommerce consumer secret
53043
+ * - apiVersion: WooCommerce API version (default: wc/v3)
52862
53044
  */
52863
53045
  SyncStoreCreateSchema: {
52864
53046
  /**
@@ -52866,27 +53048,33 @@ export interface components {
52866
53048
  * @description Human-readable name for the store
52867
53049
  */
52868
53050
  storeName: string;
52869
- /**
52870
- * @description Type of store (e.g., shopify)
52871
- * @default shopify
52872
- */
53051
+ /** @description Type of store: 'shopify' or 'wooCommerce' */
52873
53052
  storeType: components["schemas"]["StoreType"];
52874
53053
  /**
52875
53054
  * Storedomain
52876
- * @description Store domain (e.g., mystore.myshopify.com)
53055
+ * @description Store domain - For Shopify: mystore.myshopify.com, For WooCommerce: mystore.com
52877
53056
  */
52878
- storeDomain: string;
53057
+ storeDomain?: string | null;
52879
53058
  /**
52880
53059
  * Accesstoken
52881
- * @description API access token
53060
+ * @description [SHOPIFY ONLY] API access token
52882
53061
  */
52883
- accessToken: string;
53062
+ accessToken?: string | null;
53063
+ /**
53064
+ * Consumerkey
53065
+ * @description [WOOCOMMERCE ONLY] Consumer key
53066
+ */
53067
+ consumerKey?: string | null;
53068
+ /**
53069
+ * Consumersecret
53070
+ * @description [WOOCOMMERCE ONLY] Consumer secret
53071
+ */
53072
+ consumerSecret?: string | null;
52884
53073
  /**
52885
53074
  * Apiversion
52886
- * @description API version to use
52887
- * @default 2024-01
53075
+ * @description API version - For Shopify: '2024-01', For WooCommerce: 'wc/v3'
52888
53076
  */
52889
- apiVersion: string;
53077
+ apiVersion?: string | null;
52890
53078
  };
52891
53079
  /**
52892
53080
  * OnlineOrderAddressSchema
@@ -52969,6 +53157,11 @@ export interface components {
52969
53157
  financialStatus: string;
52970
53158
  /** Fulfillmentstatus */
52971
53159
  fulfillmentStatus?: string | null;
53160
+ /**
53161
+ * Woocommercestatus
53162
+ * @description Original WooCommerce order status
53163
+ */
53164
+ wooCommerceStatus?: string | null;
52972
53165
  /** Totalprice */
52973
53166
  totalPrice: number | string;
52974
53167
  /** Subtotalprice */
@@ -94670,6 +94863,267 @@ export interface operations {
94670
94863
  };
94671
94864
  };
94672
94865
  };
94866
+ integration_sync_views_sync_single_category_endpoint: {
94867
+ parameters: {
94868
+ query?: never;
94869
+ header?: never;
94870
+ path: {
94871
+ id: number;
94872
+ };
94873
+ cookie?: never;
94874
+ };
94875
+ requestBody?: never;
94876
+ responses: {
94877
+ /** @description OK */
94878
+ 200: {
94879
+ headers: {
94880
+ [name: string]: unknown;
94881
+ };
94882
+ content: {
94883
+ "application/json": components["schemas"]["MessageResponse"];
94884
+ };
94885
+ };
94886
+ /** @description Bad Request */
94887
+ 400: {
94888
+ headers: {
94889
+ [name: string]: unknown;
94890
+ };
94891
+ content: {
94892
+ "application/json": components["schemas"]["ErrorMessages"];
94893
+ };
94894
+ };
94895
+ /** @description Not Found */
94896
+ 404: {
94897
+ headers: {
94898
+ [name: string]: unknown;
94899
+ };
94900
+ content: {
94901
+ "application/json": components["schemas"]["MessageResponse"];
94902
+ };
94903
+ };
94904
+ /** @description Conflict */
94905
+ 409: {
94906
+ headers: {
94907
+ [name: string]: unknown;
94908
+ };
94909
+ content: {
94910
+ "application/json": components["schemas"]["MessageResponse"];
94911
+ };
94912
+ };
94913
+ };
94914
+ };
94915
+ integration_sync_views_sync_all_categories_endpoint: {
94916
+ parameters: {
94917
+ query?: never;
94918
+ header?: never;
94919
+ path?: never;
94920
+ cookie?: never;
94921
+ };
94922
+ requestBody?: never;
94923
+ responses: {
94924
+ /** @description OK */
94925
+ 200: {
94926
+ headers: {
94927
+ [name: string]: unknown;
94928
+ };
94929
+ content: {
94930
+ "application/json": components["schemas"]["MessageResponse"];
94931
+ };
94932
+ };
94933
+ /** @description Not Found */
94934
+ 404: {
94935
+ headers: {
94936
+ [name: string]: unknown;
94937
+ };
94938
+ content: {
94939
+ "application/json": components["schemas"]["MessageResponse"];
94940
+ };
94941
+ };
94942
+ /** @description Conflict */
94943
+ 409: {
94944
+ headers: {
94945
+ [name: string]: unknown;
94946
+ };
94947
+ content: {
94948
+ "application/json": components["schemas"]["MessageResponse"];
94949
+ };
94950
+ };
94951
+ };
94952
+ };
94953
+ integration_sync_views_sync_single_brand_endpoint: {
94954
+ parameters: {
94955
+ query?: never;
94956
+ header?: never;
94957
+ path: {
94958
+ id: number;
94959
+ };
94960
+ cookie?: never;
94961
+ };
94962
+ requestBody?: never;
94963
+ responses: {
94964
+ /** @description OK */
94965
+ 200: {
94966
+ headers: {
94967
+ [name: string]: unknown;
94968
+ };
94969
+ content: {
94970
+ "application/json": components["schemas"]["MessageResponse"];
94971
+ };
94972
+ };
94973
+ /** @description Bad Request */
94974
+ 400: {
94975
+ headers: {
94976
+ [name: string]: unknown;
94977
+ };
94978
+ content: {
94979
+ "application/json": components["schemas"]["ErrorMessages"];
94980
+ };
94981
+ };
94982
+ /** @description Not Found */
94983
+ 404: {
94984
+ headers: {
94985
+ [name: string]: unknown;
94986
+ };
94987
+ content: {
94988
+ "application/json": components["schemas"]["MessageResponse"];
94989
+ };
94990
+ };
94991
+ /** @description Conflict */
94992
+ 409: {
94993
+ headers: {
94994
+ [name: string]: unknown;
94995
+ };
94996
+ content: {
94997
+ "application/json": components["schemas"]["MessageResponse"];
94998
+ };
94999
+ };
95000
+ };
95001
+ };
95002
+ integration_sync_views_sync_all_brands_endpoint: {
95003
+ parameters: {
95004
+ query?: never;
95005
+ header?: never;
95006
+ path?: never;
95007
+ cookie?: never;
95008
+ };
95009
+ requestBody?: never;
95010
+ responses: {
95011
+ /** @description OK */
95012
+ 200: {
95013
+ headers: {
95014
+ [name: string]: unknown;
95015
+ };
95016
+ content: {
95017
+ "application/json": components["schemas"]["MessageResponse"];
95018
+ };
95019
+ };
95020
+ /** @description Not Found */
95021
+ 404: {
95022
+ headers: {
95023
+ [name: string]: unknown;
95024
+ };
95025
+ content: {
95026
+ "application/json": components["schemas"]["MessageResponse"];
95027
+ };
95028
+ };
95029
+ /** @description Conflict */
95030
+ 409: {
95031
+ headers: {
95032
+ [name: string]: unknown;
95033
+ };
95034
+ content: {
95035
+ "application/json": components["schemas"]["MessageResponse"];
95036
+ };
95037
+ };
95038
+ };
95039
+ };
95040
+ integration_sync_views_sync_single_tag_endpoint: {
95041
+ parameters: {
95042
+ query?: never;
95043
+ header?: never;
95044
+ path: {
95045
+ id: number;
95046
+ };
95047
+ cookie?: never;
95048
+ };
95049
+ requestBody?: never;
95050
+ responses: {
95051
+ /** @description OK */
95052
+ 200: {
95053
+ headers: {
95054
+ [name: string]: unknown;
95055
+ };
95056
+ content: {
95057
+ "application/json": components["schemas"]["MessageResponse"];
95058
+ };
95059
+ };
95060
+ /** @description Bad Request */
95061
+ 400: {
95062
+ headers: {
95063
+ [name: string]: unknown;
95064
+ };
95065
+ content: {
95066
+ "application/json": components["schemas"]["ErrorMessages"];
95067
+ };
95068
+ };
95069
+ /** @description Not Found */
95070
+ 404: {
95071
+ headers: {
95072
+ [name: string]: unknown;
95073
+ };
95074
+ content: {
95075
+ "application/json": components["schemas"]["MessageResponse"];
95076
+ };
95077
+ };
95078
+ /** @description Conflict */
95079
+ 409: {
95080
+ headers: {
95081
+ [name: string]: unknown;
95082
+ };
95083
+ content: {
95084
+ "application/json": components["schemas"]["MessageResponse"];
95085
+ };
95086
+ };
95087
+ };
95088
+ };
95089
+ integration_sync_views_sync_all_tags_endpoint: {
95090
+ parameters: {
95091
+ query?: never;
95092
+ header?: never;
95093
+ path?: never;
95094
+ cookie?: never;
95095
+ };
95096
+ requestBody?: never;
95097
+ responses: {
95098
+ /** @description OK */
95099
+ 200: {
95100
+ headers: {
95101
+ [name: string]: unknown;
95102
+ };
95103
+ content: {
95104
+ "application/json": components["schemas"]["MessageResponse"];
95105
+ };
95106
+ };
95107
+ /** @description Not Found */
95108
+ 404: {
95109
+ headers: {
95110
+ [name: string]: unknown;
95111
+ };
95112
+ content: {
95113
+ "application/json": components["schemas"]["MessageResponse"];
95114
+ };
95115
+ };
95116
+ /** @description Conflict */
95117
+ 409: {
95118
+ headers: {
95119
+ [name: string]: unknown;
95120
+ };
95121
+ content: {
95122
+ "application/json": components["schemas"]["MessageResponse"];
95123
+ };
95124
+ };
95125
+ };
95126
+ };
94673
95127
  integration_sync_views_sync_orders_endpoint: {
94674
95128
  parameters: {
94675
95129
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.1240",
3
+ "version": "1.0.1242",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],