@erp-galoper/types 1.0.1534 → 1.0.1536

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 +420 -9
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -20980,11 +20980,16 @@ export interface paths {
20980
20980
  * @description Endpoint for updating sync store configuration (Shopify or WooCommerce)
20981
20981
  *
20982
20982
  * Can update platform-specific fields:
20983
- * - Shopify: storeDomain, accessToken, apiVersion
20983
+ * - Shopify: storeDomain, accessToken, apiVersion, shopifyClientId, shopifyClientSecret
20984
20984
  * - WooCommerce: storeUrl, consumerKey, consumerSecret, apiVersion
20985
20985
  *
20986
+ * Note: If Shopify OAuth credentials (Client ID/Secret) are updated:
20987
+ * - Access token will be cleared automatically
20988
+ * - Store status will be set to 'pending'
20989
+ * - User must reinstall the app to get a new access token
20990
+ *
20986
20991
  * Possible Responses:
20987
- * - 200: syncStoreUpdated
20992
+ * - 200: syncStoreUpdated, oauthCredentialsUpdatedReinstallRequired
20988
20993
  * - 400: validationFailed, onlineStoreSettingNotConfigured, connectionFailed
20989
20994
  * - 404: storeDoesNotExist
20990
20995
  * - 403: permissionDenied
@@ -21010,10 +21015,49 @@ export interface paths {
21010
21015
  * permission key: onlinestore: ["add"]
21011
21016
  */
21012
21017
  post: operations["integration_sync_views_create_sync_store"];
21013
- delete?: never;
21018
+ /**
21019
+ * Delete Sync Store
21020
+ * @description Endpoint for deleting sync store configuration
21021
+ *
21022
+ * This will delete:
21023
+ * - The store configuration
21024
+ * - All sync mappings related to this store
21025
+ * - All sync logs related to this store
21026
+ * - All sync jobs related to this store
21027
+ *
21028
+ * Possible Responses:
21029
+ * - 200: syncStoreDeleted
21030
+ * - 404: storeDoesNotExist
21031
+ * - 403: permissionDenied
21032
+ * - 500: unexpectedError
21033
+ *
21034
+ * permission key: onlinestore: ["delete"]
21035
+ */
21036
+ delete: operations["integration_sync_views_delete_sync_store"];
21014
21037
  options?: never;
21015
21038
  head?: never;
21016
- patch?: never;
21039
+ /**
21040
+ * Patch Sync Store
21041
+ * @description Endpoint for partially updating sync store configuration (Shopify or WooCommerce)
21042
+ *
21043
+ * Can update all fields EXCEPT storeDomain (domain cannot be changed after creation).
21044
+ * Only provide the fields you want to update.
21045
+ *
21046
+ * Note: If Shopify OAuth credentials (Client ID/Secret) are updated:
21047
+ * - Access token will be cleared automatically
21048
+ * - Store status will be set to 'pending'
21049
+ * - User must reinstall the app to get a new access token
21050
+ *
21051
+ * Possible Responses:
21052
+ * - 200: syncStoreUpdated, oauthCredentialsUpdatedReinstallRequired
21053
+ * - 400: validationFailed, connectionFailed, storeDomainImmutable
21054
+ * - 404: storeDoesNotExist
21055
+ * - 403: permissionDenied
21056
+ * - 500: unexpectedError
21057
+ *
21058
+ * permission key: onlinestore: ["change"]
21059
+ */
21060
+ patch: operations["integration_sync_views_patch_sync_store"];
21017
21061
  trace?: never;
21018
21062
  };
21019
21063
  "/api/v1/integrations/sync/store/test-connection/": {
@@ -21338,6 +21382,77 @@ export interface paths {
21338
21382
  patch?: never;
21339
21383
  trace?: never;
21340
21384
  };
21385
+ "/api/v1/integrations/sync/shopify/app": {
21386
+ parameters: {
21387
+ query?: never;
21388
+ header?: never;
21389
+ path?: never;
21390
+ cookie?: never;
21391
+ };
21392
+ /**
21393
+ * Shopify App Entry
21394
+ * @description Shopify App Entry Point
21395
+ *
21396
+ * This is the main App URL that Shopify redirects to when the user installs your app.
21397
+ * It checks if the store is already authenticated:
21398
+ * - If YES: Shows app interface (or redirects to your frontend)
21399
+ * - If NO: Initiates OAuth flow
21400
+ *
21401
+ * Query Parameters (sent by Shopify):
21402
+ * - shop: Shopify store domain (e.g., mystore.myshopify.com)
21403
+ * - host: Base64 encoded shop/id (used for embedded apps)
21404
+ *
21405
+ * This should be set as your "App URL" in Shopify Partner Dashboard
21406
+ */
21407
+ get: operations["integration_sync_views_shopify_app_entry"];
21408
+ put?: never;
21409
+ post?: never;
21410
+ delete?: never;
21411
+ options?: never;
21412
+ head?: never;
21413
+ patch?: never;
21414
+ trace?: never;
21415
+ };
21416
+ "/api/v1/integrations/sync/shopify/oauth/callback": {
21417
+ parameters: {
21418
+ query?: never;
21419
+ header?: never;
21420
+ path?: never;
21421
+ cookie?: never;
21422
+ };
21423
+ /**
21424
+ * Shopify Oauth Callback
21425
+ * @description Shopify OAuth callback endpoint
21426
+ *
21427
+ * Shopify redirects here after the user approves the app installation.
21428
+ * This endpoint:
21429
+ * 1. Verifies the HMAC signature
21430
+ * 2. Exchanges the temporary code for a permanent access token
21431
+ * 3. Fetches shop information
21432
+ * 4. Creates or updates the SyncStore configuration
21433
+ *
21434
+ * Query Parameters (automatically sent by Shopify):
21435
+ * - shop: Shopify store domain
21436
+ * - code: Temporary authorization code
21437
+ * - hmac: HMAC signature for verification
21438
+ * - timestamp: Request timestamp
21439
+ * - state: Optional state parameter (if provided during install)
21440
+ * - host: Optional Shopify host parameter
21441
+ *
21442
+ * Returns:
21443
+ * - 200: Installation successful, store created/updated
21444
+ * - 400: Validation failed or HMAC verification failed
21445
+ * - 500: Token exchange or store creation failed
21446
+ */
21447
+ get: operations["integration_sync_views_shopify_oauth_callback"];
21448
+ put?: never;
21449
+ post?: never;
21450
+ delete?: never;
21451
+ options?: never;
21452
+ head?: never;
21453
+ patch?: never;
21454
+ trace?: never;
21455
+ };
21341
21456
  "/api/v1/integrations/whatsapp/setup/": {
21342
21457
  parameters: {
21343
21458
  query?: never;
@@ -56318,12 +56433,13 @@ export interface components {
56318
56433
  *
56319
56434
  * For Shopify:
56320
56435
  * - storeDomain: Store domain (e.g., mystore.myshopify.com)
56321
- * - accessToken: Shopify API access token
56436
+ * - shopifyClientId: Shopify app Client ID (for OAuth)
56437
+ * - shopifyClientSecret: Shopify app Client Secret (for OAuth)
56322
56438
  * - apiVersion: Shopify API version (default: 2024-01)
56323
56439
  *
56324
56440
  * For WooCommerce:
56325
56441
  * - storeDomain: Store domain (e.g., mystore.com)
56326
- * - accessToken: WooCommerce consumer key
56442
+ * - consumerKey: WooCommerce consumer key
56327
56443
  * - consumerSecret: WooCommerce consumer secret
56328
56444
  * - apiVersion: WooCommerce API version (default: wc/v3)
56329
56445
  */
@@ -56341,10 +56457,54 @@ export interface components {
56341
56457
  */
56342
56458
  storeDomain?: string | null;
56343
56459
  /**
56344
- * Accesstoken
56345
- * @description [SHOPIFY ONLY] API access token
56460
+ * Shopifyclientid
56461
+ * @description [SHOPIFY ONLY] Shopify app Client ID for OAuth
56462
+ */
56463
+ shopifyClientId?: string | null;
56464
+ /**
56465
+ * Shopifyclientsecret
56466
+ * @description [SHOPIFY ONLY] Shopify app Client Secret for OAuth
56467
+ */
56468
+ shopifyClientSecret?: string | null;
56469
+ /**
56470
+ * Consumerkey
56471
+ * @description [WOOCOMMERCE ONLY] Consumer key
56472
+ */
56473
+ consumerKey?: string | null;
56474
+ /**
56475
+ * Consumersecret
56476
+ * @description [WOOCOMMERCE ONLY] Consumer secret
56477
+ */
56478
+ consumerSecret?: string | null;
56479
+ /**
56480
+ * Apiversion
56481
+ * @description API version - For Shopify: '2024-01', For WooCommerce: 'wc/v3'
56346
56482
  */
56347
- accessToken?: string | null;
56483
+ apiVersion?: string | null;
56484
+ };
56485
+ /**
56486
+ * SyncStoreUpdateSchema
56487
+ * @description Schema for updating a sync store (PATCH)
56488
+ *
56489
+ * All fields are optional except storeDomain which cannot be changed.
56490
+ * Only provide the fields you want to update.
56491
+ */
56492
+ SyncStoreUpdateSchema: {
56493
+ /**
56494
+ * Storename
56495
+ * @description Human-readable name for the store
56496
+ */
56497
+ storeName?: string | null;
56498
+ /**
56499
+ * Shopifyclientid
56500
+ * @description [SHOPIFY ONLY] Shopify app Client ID
56501
+ */
56502
+ shopifyClientId?: string | null;
56503
+ /**
56504
+ * Shopifyclientsecret
56505
+ * @description [SHOPIFY ONLY] Shopify app Client Secret
56506
+ */
56507
+ shopifyClientSecret?: string | null;
56348
56508
  /**
56349
56509
  * Consumerkey
56350
56510
  * @description [WOOCOMMERCE ONLY] Consumer key
@@ -56530,6 +56690,25 @@ export interface components {
56530
56690
  * @enum {string}
56531
56691
  */
56532
56692
  PaymentMethodType: "credit_card" | "debit_card" | "cash_on_delivery" | "bank_transfer" | "paypal" | "apple_pay" | "google_pay" | "shopify_payments" | "manual" | "other";
56693
+ /**
56694
+ * ShopifyOAuthResponseSchema
56695
+ * @description Schema for successful OAuth installation response
56696
+ */
56697
+ ShopifyOAuthResponseSchema: {
56698
+ /** Success */
56699
+ success: boolean;
56700
+ /** Message */
56701
+ message: string;
56702
+ /**
56703
+ * Store Id
56704
+ * Format: uuid
56705
+ */
56706
+ store_id: string;
56707
+ /** Store Name */
56708
+ store_name: string;
56709
+ /** Shop Domain */
56710
+ shop_domain: string;
56711
+ };
56533
56712
  /**
56534
56713
  * WhatsAppIntegrationResponseSchema
56535
56714
  * @description Schema for returning WhatsApp integration information.
@@ -99653,6 +99832,113 @@ export interface operations {
99653
99832
  };
99654
99833
  };
99655
99834
  };
99835
+ integration_sync_views_delete_sync_store: {
99836
+ parameters: {
99837
+ query?: never;
99838
+ header?: never;
99839
+ path?: never;
99840
+ cookie?: never;
99841
+ };
99842
+ requestBody?: never;
99843
+ responses: {
99844
+ /** @description OK */
99845
+ 200: {
99846
+ headers: {
99847
+ [name: string]: unknown;
99848
+ };
99849
+ content: {
99850
+ "application/json": components["schemas"]["MessageResponse"];
99851
+ };
99852
+ };
99853
+ /** @description Forbidden */
99854
+ 403: {
99855
+ headers: {
99856
+ [name: string]: unknown;
99857
+ };
99858
+ content: {
99859
+ "application/json": components["schemas"]["MessageResponse"];
99860
+ };
99861
+ };
99862
+ /** @description Not Found */
99863
+ 404: {
99864
+ headers: {
99865
+ [name: string]: unknown;
99866
+ };
99867
+ content: {
99868
+ "application/json": components["schemas"]["MessageResponse"];
99869
+ };
99870
+ };
99871
+ /** @description Internal Server Error */
99872
+ 500: {
99873
+ headers: {
99874
+ [name: string]: unknown;
99875
+ };
99876
+ content: {
99877
+ "application/json": components["schemas"]["MessageResponse"];
99878
+ };
99879
+ };
99880
+ };
99881
+ };
99882
+ integration_sync_views_patch_sync_store: {
99883
+ parameters: {
99884
+ query?: never;
99885
+ header?: never;
99886
+ path?: never;
99887
+ cookie?: never;
99888
+ };
99889
+ requestBody: {
99890
+ content: {
99891
+ "application/json": components["schemas"]["SyncStoreUpdateSchema"];
99892
+ };
99893
+ };
99894
+ responses: {
99895
+ /** @description OK */
99896
+ 200: {
99897
+ headers: {
99898
+ [name: string]: unknown;
99899
+ };
99900
+ content: {
99901
+ "application/json": components["schemas"]["SyncStoreSchema"];
99902
+ };
99903
+ };
99904
+ /** @description Bad Request */
99905
+ 400: {
99906
+ headers: {
99907
+ [name: string]: unknown;
99908
+ };
99909
+ content: {
99910
+ "application/json": components["schemas"]["ErrorMessages"];
99911
+ };
99912
+ };
99913
+ /** @description Forbidden */
99914
+ 403: {
99915
+ headers: {
99916
+ [name: string]: unknown;
99917
+ };
99918
+ content: {
99919
+ "application/json": components["schemas"]["MessageResponse"];
99920
+ };
99921
+ };
99922
+ /** @description Not Found */
99923
+ 404: {
99924
+ headers: {
99925
+ [name: string]: unknown;
99926
+ };
99927
+ content: {
99928
+ "application/json": components["schemas"]["MessageResponse"];
99929
+ };
99930
+ };
99931
+ /** @description Internal Server Error */
99932
+ 500: {
99933
+ headers: {
99934
+ [name: string]: unknown;
99935
+ };
99936
+ content: {
99937
+ "application/json": components["schemas"]["MessageResponse"];
99938
+ };
99939
+ };
99940
+ };
99941
+ };
99656
99942
  integration_sync_views_test_sync_store_connection: {
99657
99943
  parameters: {
99658
99944
  query?: never;
@@ -100357,6 +100643,131 @@ export interface operations {
100357
100643
  "application/json": components["schemas"]["MessageResponse"];
100358
100644
  };
100359
100645
  };
100646
+ /** @description Internal Server Error */
100647
+ 500: {
100648
+ headers: {
100649
+ [name: string]: unknown;
100650
+ };
100651
+ content: {
100652
+ "application/json": components["schemas"]["MessageResponse"];
100653
+ };
100654
+ };
100655
+ };
100656
+ };
100657
+ integration_sync_views_shopify_app_entry: {
100658
+ parameters: {
100659
+ query: {
100660
+ /** @description Shopify store domain */
100661
+ shop: string;
100662
+ /** @description Shopify host parameter */
100663
+ host?: string | null;
100664
+ /** @description Embedded app indicator */
100665
+ embedded?: string | null;
100666
+ /** @description HMAC signature */
100667
+ hmac?: string | null;
100668
+ /** @description Shopify ID token */
100669
+ id_token?: string | null;
100670
+ /** @description User locale */
100671
+ locale?: string | null;
100672
+ /** @description Session ID */
100673
+ session?: string | null;
100674
+ /** @description Request timestamp */
100675
+ timestamp?: string | null;
100676
+ };
100677
+ header?: never;
100678
+ path?: never;
100679
+ cookie?: never;
100680
+ };
100681
+ requestBody?: never;
100682
+ responses: {
100683
+ /** @description OK */
100684
+ 200: {
100685
+ headers: {
100686
+ [name: string]: unknown;
100687
+ };
100688
+ content: {
100689
+ "application/json": Record<string, never>;
100690
+ };
100691
+ };
100692
+ /** @description Found */
100693
+ 302: {
100694
+ headers: {
100695
+ [name: string]: unknown;
100696
+ };
100697
+ content?: never;
100698
+ };
100699
+ /** @description Bad Request */
100700
+ 400: {
100701
+ headers: {
100702
+ [name: string]: unknown;
100703
+ };
100704
+ content: {
100705
+ "application/json": components["schemas"]["ErrorMessages"];
100706
+ };
100707
+ };
100708
+ /** @description Internal Server Error */
100709
+ 500: {
100710
+ headers: {
100711
+ [name: string]: unknown;
100712
+ };
100713
+ content: {
100714
+ "application/json": components["schemas"]["MessageResponse"];
100715
+ };
100716
+ };
100717
+ };
100718
+ };
100719
+ integration_sync_views_shopify_oauth_callback: {
100720
+ parameters: {
100721
+ query: {
100722
+ shop: string;
100723
+ code: string;
100724
+ hmac: string;
100725
+ timestamp: string;
100726
+ state?: string | null;
100727
+ host?: string | null;
100728
+ };
100729
+ header?: never;
100730
+ path?: never;
100731
+ cookie?: never;
100732
+ };
100733
+ requestBody?: never;
100734
+ responses: {
100735
+ /** @description OK */
100736
+ 200: {
100737
+ headers: {
100738
+ [name: string]: unknown;
100739
+ };
100740
+ content: {
100741
+ "application/json": components["schemas"]["ShopifyOAuthResponseSchema"];
100742
+ };
100743
+ };
100744
+ /** @description Bad Request */
100745
+ 400: {
100746
+ headers: {
100747
+ [name: string]: unknown;
100748
+ };
100749
+ content: {
100750
+ "application/json": components["schemas"]["ErrorMessages"];
100751
+ };
100752
+ };
100753
+ /** @description Forbidden */
100754
+ 403: {
100755
+ headers: {
100756
+ [name: string]: unknown;
100757
+ };
100758
+ content: {
100759
+ "application/json": components["schemas"]["MessageResponse"];
100760
+ };
100761
+ };
100762
+ /** @description Internal Server Error */
100763
+ 500: {
100764
+ headers: {
100765
+ [name: string]: unknown;
100766
+ };
100767
+ content: {
100768
+ "application/json": components["schemas"]["MessageResponse"];
100769
+ };
100770
+ };
100360
100771
  };
100361
100772
  };
100362
100773
  integration_whatsapp_views_get_whatsapp_integration: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.1534",
3
+ "version": "1.0.1536",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],