@rippling/rippling-sdk 0.2.0-alpha.96 → 0.2.0-alpha.98

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 (113) hide show
  1. package/client.d.mts +37 -4
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +37 -4
  4. package/client.d.ts.map +1 -1
  5. package/client.js +33 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +34 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +2 -1
  10. package/resources/draft-transitions.d.mts +474 -0
  11. package/resources/draft-transitions.d.mts.map +1 -0
  12. package/resources/draft-transitions.d.ts +474 -0
  13. package/resources/draft-transitions.d.ts.map +1 -0
  14. package/resources/draft-transitions.js +25 -0
  15. package/resources/draft-transitions.js.map +1 -0
  16. package/resources/draft-transitions.mjs +21 -0
  17. package/resources/draft-transitions.mjs.map +1 -0
  18. package/resources/index.d.mts +7 -2
  19. package/resources/index.d.mts.map +1 -1
  20. package/resources/index.d.ts +7 -2
  21. package/resources/index.d.ts.map +1 -1
  22. package/resources/index.js +12 -2
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs +6 -1
  25. package/resources/index.mjs.map +1 -1
  26. package/resources/metadata/index.d.mts +1 -1
  27. package/resources/metadata/index.d.mts.map +1 -1
  28. package/resources/metadata/index.d.ts +1 -1
  29. package/resources/metadata/index.d.ts.map +1 -1
  30. package/resources/metadata/index.js.map +1 -1
  31. package/resources/metadata/index.mjs +1 -1
  32. package/resources/metadata/index.mjs.map +1 -1
  33. package/resources/metadata/metadata.d.mts +47 -1
  34. package/resources/metadata/metadata.d.mts.map +1 -1
  35. package/resources/metadata/metadata.d.ts +47 -1
  36. package/resources/metadata/metadata.d.ts.map +1 -1
  37. package/resources/metadata/metadata.js +15 -0
  38. package/resources/metadata/metadata.js.map +1 -1
  39. package/resources/metadata/metadata.mjs +15 -0
  40. package/resources/metadata/metadata.mjs.map +1 -1
  41. package/resources/package-managed-installs.d.mts +119 -0
  42. package/resources/package-managed-installs.d.mts.map +1 -0
  43. package/resources/package-managed-installs.d.ts +119 -0
  44. package/resources/package-managed-installs.d.ts.map +1 -0
  45. package/resources/package-managed-installs.js +26 -0
  46. package/resources/package-managed-installs.js.map +1 -0
  47. package/resources/package-managed-installs.mjs +22 -0
  48. package/resources/package-managed-installs.mjs.map +1 -0
  49. package/resources/sandboxes.d.mts +224 -1
  50. package/resources/sandboxes.d.mts.map +1 -1
  51. package/resources/sandboxes.d.ts +224 -1
  52. package/resources/sandboxes.d.ts.map +1 -1
  53. package/resources/sandboxes.js +6 -0
  54. package/resources/sandboxes.js.map +1 -1
  55. package/resources/sandboxes.mjs +6 -0
  56. package/resources/sandboxes.mjs.map +1 -1
  57. package/resources/sites.d.mts +3 -0
  58. package/resources/sites.d.mts.map +1 -1
  59. package/resources/sites.d.ts +3 -0
  60. package/resources/sites.d.ts.map +1 -1
  61. package/resources/sites.js +3 -0
  62. package/resources/sites.js.map +1 -1
  63. package/resources/sites.mjs +3 -0
  64. package/resources/sites.mjs.map +1 -1
  65. package/resources/variable-compensation-payout-labels.d.mts +155 -0
  66. package/resources/variable-compensation-payout-labels.d.mts.map +1 -0
  67. package/resources/variable-compensation-payout-labels.d.ts +155 -0
  68. package/resources/variable-compensation-payout-labels.d.ts.map +1 -0
  69. package/resources/variable-compensation-payout-labels.js +41 -0
  70. package/resources/variable-compensation-payout-labels.js.map +1 -0
  71. package/resources/variable-compensation-payout-labels.mjs +37 -0
  72. package/resources/variable-compensation-payout-labels.mjs.map +1 -0
  73. package/resources/variable-compensation-payout-types.d.mts +334 -0
  74. package/resources/variable-compensation-payout-types.d.mts.map +1 -0
  75. package/resources/variable-compensation-payout-types.d.ts +334 -0
  76. package/resources/variable-compensation-payout-types.d.ts.map +1 -0
  77. package/resources/variable-compensation-payout-types.js +52 -0
  78. package/resources/variable-compensation-payout-types.js.map +1 -0
  79. package/resources/variable-compensation-payout-types.mjs +48 -0
  80. package/resources/variable-compensation-payout-types.mjs.map +1 -0
  81. package/resources/variable-compensation-payout-writes.d.mts +6 -17
  82. package/resources/variable-compensation-payout-writes.d.mts.map +1 -1
  83. package/resources/variable-compensation-payout-writes.d.ts +6 -17
  84. package/resources/variable-compensation-payout-writes.d.ts.map +1 -1
  85. package/resources/variable-compensation-payout-writes.js +2 -1
  86. package/resources/variable-compensation-payout-writes.js.map +1 -1
  87. package/resources/variable-compensation-payout-writes.mjs +2 -1
  88. package/resources/variable-compensation-payout-writes.mjs.map +1 -1
  89. package/resources/variable-compensation-payouts.d.mts +501 -0
  90. package/resources/variable-compensation-payouts.d.mts.map +1 -0
  91. package/resources/variable-compensation-payouts.d.ts +501 -0
  92. package/resources/variable-compensation-payouts.d.ts.map +1 -0
  93. package/resources/variable-compensation-payouts.js +41 -0
  94. package/resources/variable-compensation-payouts.js.map +1 -0
  95. package/resources/variable-compensation-payouts.mjs +37 -0
  96. package/resources/variable-compensation-payouts.mjs.map +1 -0
  97. package/src/client.ts +130 -1
  98. package/src/resources/draft-transitions.ts +583 -0
  99. package/src/resources/index.ts +50 -1
  100. package/src/resources/metadata/index.ts +7 -1
  101. package/src/resources/metadata/metadata.ts +54 -0
  102. package/src/resources/package-managed-installs.ts +156 -0
  103. package/src/resources/sandboxes.ts +265 -0
  104. package/src/resources/sites.ts +3 -0
  105. package/src/resources/variable-compensation-payout-labels.ts +227 -0
  106. package/src/resources/variable-compensation-payout-types.ts +440 -0
  107. package/src/resources/variable-compensation-payout-writes.ts +6 -20
  108. package/src/resources/variable-compensation-payouts.ts +702 -0
  109. package/src/version.ts +1 -1
  110. package/version.d.mts +1 -1
  111. package/version.d.ts +1 -1
  112. package/version.js +1 -1
  113. package/version.mjs +1 -1
package/src/client.ts CHANGED
@@ -202,6 +202,12 @@ import {
202
202
  Devices,
203
203
  } from './resources/devices';
204
204
  import { DraftHireCreateParams, DraftHireCreateResponse, DraftHires } from './resources/draft-hires';
205
+ import {
206
+ DraftTransitionCreateParams,
207
+ DraftTransitionCreateResponse,
208
+ DraftTransitionRetrieveResponse,
209
+ DraftTransitions,
210
+ } from './resources/draft-transitions';
205
211
  import {
206
212
  EarningTypeListParams,
207
213
  EarningTypeListResponse,
@@ -447,6 +453,12 @@ import {
447
453
  PackageInstallRetrieveResponse,
448
454
  PackageInstalls,
449
455
  } from './resources/package-installs';
456
+ import {
457
+ PackageManagedInstallCreateParams,
458
+ PackageManagedInstallCreateResponse,
459
+ PackageManagedInstallRetrieveResponse,
460
+ PackageManagedInstalls,
461
+ } from './resources/package-managed-installs';
450
462
  import {
451
463
  PackageSandboxLinkCreateParams,
452
464
  PackageSandboxLinkCreateResponse,
@@ -489,6 +501,7 @@ import {
489
501
  SandboxListParams,
490
502
  SandboxListResponse,
491
503
  SandboxListResponsesPageCursorURL,
504
+ SandboxRetrieveResponse,
492
505
  Sandboxes,
493
506
  } from './resources/sandboxes';
494
507
  import {
@@ -642,11 +655,41 @@ import {
642
655
  Unassignedshifts,
643
656
  } from './resources/unassignedshifts';
644
657
  import { User, UserListParams, UserRetrieveResponse, Users, UsersPageCursorURL } from './resources/users';
658
+ import {
659
+ VariableCompensationPayoutLabelCreateParams,
660
+ VariableCompensationPayoutLabelCreateResponse,
661
+ VariableCompensationPayoutLabelListParams,
662
+ VariableCompensationPayoutLabelListResponse,
663
+ VariableCompensationPayoutLabelListResponsesPageCursorURL,
664
+ VariableCompensationPayoutLabelRetrieveResponse,
665
+ VariableCompensationPayoutLabelUpdateParams,
666
+ VariableCompensationPayoutLabelUpdateResponse,
667
+ VariableCompensationPayoutLabels,
668
+ } from './resources/variable-compensation-payout-labels';
669
+ import {
670
+ VariableCompensationPayoutTypeCreateParams,
671
+ VariableCompensationPayoutTypeCreateResponse,
672
+ VariableCompensationPayoutTypeListResponse,
673
+ VariableCompensationPayoutTypeListResponsesPageCursorURL,
674
+ VariableCompensationPayoutTypeRetrieveResponse,
675
+ VariableCompensationPayoutTypeUpdateParams,
676
+ VariableCompensationPayoutTypeUpdateResponse,
677
+ VariableCompensationPayoutTypes,
678
+ } from './resources/variable-compensation-payout-types';
645
679
  import {
646
680
  VariableCompensationPayoutWriteCreateParams,
647
681
  VariableCompensationPayoutWriteCreateResponse,
648
682
  VariableCompensationPayoutWrites,
649
683
  } from './resources/variable-compensation-payout-writes';
684
+ import {
685
+ VariableCompensationPayoutCreateParams,
686
+ VariableCompensationPayoutCreateResponse,
687
+ VariableCompensationPayoutListParams,
688
+ VariableCompensationPayoutListResponse,
689
+ VariableCompensationPayoutListResponsesPageCursorURL,
690
+ VariableCompensationPayoutRetrieveResponse,
691
+ VariableCompensationPayouts,
692
+ } from './resources/variable-compensation-payouts';
650
693
  import {
651
694
  WorkLocation,
652
695
  WorkLocationCreateParams,
@@ -735,7 +778,13 @@ import {
735
778
  Functions,
736
779
  FunctionsPageCursorURL,
737
780
  } from './resources/functions/functions';
738
- import { Metadata, MetadataExtractParams, MetadataExtractResponse } from './resources/metadata/metadata';
781
+ import {
782
+ Metadata,
783
+ MetadataExtractByIdentifiersParams,
784
+ MetadataExtractByIdentifiersResponse,
785
+ MetadataExtractParams,
786
+ MetadataExtractResponse,
787
+ } from './resources/metadata/metadata';
739
788
  import {
740
789
  PackageVersionRetrieveResponse,
741
790
  PackageVersionUpdateParams,
@@ -1704,6 +1753,10 @@ export class RipplingSDK {
1704
1753
  * Candidates who have not yet started work at the company
1705
1754
  */
1706
1755
  draftHires: API.DraftHires = new API.DraftHires(this);
1756
+ /**
1757
+ * Proposed changes to existing workers that can be reviewed in Rippling
1758
+ */
1759
+ draftTransitions: API.DraftTransitions = new API.DraftTransitions(this);
1707
1760
  /**
1708
1761
  * Earning types configured for the company
1709
1762
  */
@@ -1780,6 +1833,10 @@ export class RipplingSDK {
1780
1833
  * Author, publish, and install Unity Packages V2 packages
1781
1834
  */
1782
1835
  packageInstalls: API.PackageInstalls = new API.PackageInstalls(this);
1836
+ /**
1837
+ * Author, publish, and install Unity Packages V2 packages
1838
+ */
1839
+ packageManagedInstalls: API.PackageManagedInstalls = new API.PackageManagedInstalls(this);
1783
1840
  /**
1784
1841
  * Author, publish, and install Unity Packages V2 packages
1785
1842
  */
@@ -1834,6 +1891,9 @@ export class RipplingSDK {
1834
1891
  * Shift assignments assigned to workers
1835
1892
  */
1836
1893
  shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
1894
+ /**
1895
+ * Custom sites hosted on Rippling
1896
+ */
1837
1897
  sites: API.Sites = new API.Sites(this);
1838
1898
  /**
1839
1899
  * Software deployed to company devices
@@ -1847,6 +1907,20 @@ export class RipplingSDK {
1847
1907
  * Unassigned shifts that are part of a schedule
1848
1908
  */
1849
1909
  unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
1910
+ /**
1911
+ * Compensation associated with workers
1912
+ */
1913
+ variableCompensationPayouts: API.VariableCompensationPayouts = new API.VariableCompensationPayouts(this);
1914
+ /**
1915
+ * Compensation associated with workers
1916
+ */
1917
+ variableCompensationPayoutLabels: API.VariableCompensationPayoutLabels =
1918
+ new API.VariableCompensationPayoutLabels(this);
1919
+ /**
1920
+ * Compensation associated with workers
1921
+ */
1922
+ variableCompensationPayoutTypes: API.VariableCompensationPayoutTypes =
1923
+ new API.VariableCompensationPayoutTypes(this);
1850
1924
  /**
1851
1925
  * Compensation associated with workers
1852
1926
  */
@@ -1936,6 +2010,7 @@ RipplingSDK.DeveloperUsers = DeveloperUsers;
1936
2010
  RipplingSDK.Devices = Devices;
1937
2011
  RipplingSDK.DeviceOrders = DeviceOrders;
1938
2012
  RipplingSDK.DraftHires = DraftHires;
2013
+ RipplingSDK.DraftTransitions = DraftTransitions;
1939
2014
  RipplingSDK.EarningTypes = EarningTypes;
1940
2015
  RipplingSDK.EarningsInputs = EarningsInputs;
1941
2016
  RipplingSDK.EmployeeDocuments = EmployeeDocuments;
@@ -1955,6 +2030,7 @@ RipplingSDK.ListingTransitions = ListingTransitions;
1955
2030
  RipplingSDK.LocationFactors = LocationFactors;
1956
2031
  RipplingSDK.Packages = Packages;
1957
2032
  RipplingSDK.PackageInstalls = PackageInstalls;
2033
+ RipplingSDK.PackageManagedInstalls = PackageManagedInstalls;
1958
2034
  RipplingSDK.PackageSandboxLinks = PackageSandboxLinks;
1959
2035
  RipplingSDK.PackageUninstalls = PackageUninstalls;
1960
2036
  RipplingSDK.PackageUpgrades = PackageUpgrades;
@@ -1972,6 +2048,9 @@ RipplingSDK.Sites = Sites;
1972
2048
  RipplingSDK.SoftwareDeployments = SoftwareDeployments;
1973
2049
  RipplingSDK.Titles = Titles;
1974
2050
  RipplingSDK.Unassignedshifts = Unassignedshifts;
2051
+ RipplingSDK.VariableCompensationPayouts = VariableCompensationPayouts;
2052
+ RipplingSDK.VariableCompensationPayoutLabels = VariableCompensationPayoutLabels;
2053
+ RipplingSDK.VariableCompensationPayoutTypes = VariableCompensationPayoutTypes;
1975
2054
  RipplingSDK.VariableCompensationPayoutWrites = VariableCompensationPayoutWrites;
1976
2055
  RipplingSDK.WorkerChanges = WorkerChanges;
1977
2056
  RipplingSDK.WorkerChangeFields = WorkerChangeFields;
@@ -2470,6 +2549,13 @@ export declare namespace RipplingSDK {
2470
2549
  type DraftHireCreateParams as DraftHireCreateParams,
2471
2550
  };
2472
2551
 
2552
+ export {
2553
+ DraftTransitions as DraftTransitions,
2554
+ type DraftTransitionRetrieveResponse as DraftTransitionRetrieveResponse,
2555
+ type DraftTransitionCreateResponse as DraftTransitionCreateResponse,
2556
+ type DraftTransitionCreateParams as DraftTransitionCreateParams,
2557
+ };
2558
+
2473
2559
  export {
2474
2560
  EarningTypes as EarningTypes,
2475
2561
  type EarningTypeListResponse as EarningTypeListResponse,
@@ -2629,6 +2715,13 @@ export declare namespace RipplingSDK {
2629
2715
  type PackageInstallCreateParams as PackageInstallCreateParams,
2630
2716
  };
2631
2717
 
2718
+ export {
2719
+ PackageManagedInstalls as PackageManagedInstalls,
2720
+ type PackageManagedInstallCreateResponse as PackageManagedInstallCreateResponse,
2721
+ type PackageManagedInstallRetrieveResponse as PackageManagedInstallRetrieveResponse,
2722
+ type PackageManagedInstallCreateParams as PackageManagedInstallCreateParams,
2723
+ };
2724
+
2632
2725
  export {
2633
2726
  PackageSandboxLinks as PackageSandboxLinks,
2634
2727
  type PackageSandboxLinkCreateResponse as PackageSandboxLinkCreateResponse,
@@ -2691,6 +2784,7 @@ export declare namespace RipplingSDK {
2691
2784
  Sandboxes as Sandboxes,
2692
2785
  type SandboxListResponse as SandboxListResponse,
2693
2786
  type SandboxCreateResponse as SandboxCreateResponse,
2787
+ type SandboxRetrieveResponse as SandboxRetrieveResponse,
2694
2788
  type SandboxDeveloperSandboxEntryRolesResponse as SandboxDeveloperSandboxEntryRolesResponse,
2695
2789
  type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
2696
2790
  type SandboxListParams as SandboxListParams,
@@ -2787,6 +2881,39 @@ export declare namespace RipplingSDK {
2787
2881
  type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
2788
2882
  };
2789
2883
 
2884
+ export {
2885
+ VariableCompensationPayouts as VariableCompensationPayouts,
2886
+ type VariableCompensationPayoutListResponse as VariableCompensationPayoutListResponse,
2887
+ type VariableCompensationPayoutCreateResponse as VariableCompensationPayoutCreateResponse,
2888
+ type VariableCompensationPayoutRetrieveResponse as VariableCompensationPayoutRetrieveResponse,
2889
+ type VariableCompensationPayoutListResponsesPageCursorURL as VariableCompensationPayoutListResponsesPageCursorURL,
2890
+ type VariableCompensationPayoutListParams as VariableCompensationPayoutListParams,
2891
+ type VariableCompensationPayoutCreateParams as VariableCompensationPayoutCreateParams,
2892
+ };
2893
+
2894
+ export {
2895
+ VariableCompensationPayoutLabels as VariableCompensationPayoutLabels,
2896
+ type VariableCompensationPayoutLabelListResponse as VariableCompensationPayoutLabelListResponse,
2897
+ type VariableCompensationPayoutLabelCreateResponse as VariableCompensationPayoutLabelCreateResponse,
2898
+ type VariableCompensationPayoutLabelRetrieveResponse as VariableCompensationPayoutLabelRetrieveResponse,
2899
+ type VariableCompensationPayoutLabelUpdateResponse as VariableCompensationPayoutLabelUpdateResponse,
2900
+ type VariableCompensationPayoutLabelListResponsesPageCursorURL as VariableCompensationPayoutLabelListResponsesPageCursorURL,
2901
+ type VariableCompensationPayoutLabelListParams as VariableCompensationPayoutLabelListParams,
2902
+ type VariableCompensationPayoutLabelCreateParams as VariableCompensationPayoutLabelCreateParams,
2903
+ type VariableCompensationPayoutLabelUpdateParams as VariableCompensationPayoutLabelUpdateParams,
2904
+ };
2905
+
2906
+ export {
2907
+ VariableCompensationPayoutTypes as VariableCompensationPayoutTypes,
2908
+ type VariableCompensationPayoutTypeListResponse as VariableCompensationPayoutTypeListResponse,
2909
+ type VariableCompensationPayoutTypeCreateResponse as VariableCompensationPayoutTypeCreateResponse,
2910
+ type VariableCompensationPayoutTypeRetrieveResponse as VariableCompensationPayoutTypeRetrieveResponse,
2911
+ type VariableCompensationPayoutTypeUpdateResponse as VariableCompensationPayoutTypeUpdateResponse,
2912
+ type VariableCompensationPayoutTypeListResponsesPageCursorURL as VariableCompensationPayoutTypeListResponsesPageCursorURL,
2913
+ type VariableCompensationPayoutTypeCreateParams as VariableCompensationPayoutTypeCreateParams,
2914
+ type VariableCompensationPayoutTypeUpdateParams as VariableCompensationPayoutTypeUpdateParams,
2915
+ };
2916
+
2790
2917
  export {
2791
2918
  VariableCompensationPayoutWrites as VariableCompensationPayoutWrites,
2792
2919
  type VariableCompensationPayoutWriteCreateResponse as VariableCompensationPayoutWriteCreateResponse,
@@ -2857,7 +2984,9 @@ export declare namespace RipplingSDK {
2857
2984
  export {
2858
2985
  Metadata as Metadata,
2859
2986
  type MetadataExtractResponse as MetadataExtractResponse,
2987
+ type MetadataExtractByIdentifiersResponse as MetadataExtractByIdentifiersResponse,
2860
2988
  type MetadataExtractParams as MetadataExtractParams,
2989
+ type MetadataExtractByIdentifiersParams as MetadataExtractByIdentifiersParams,
2861
2990
  };
2862
2991
 
2863
2992
  export type Address = API.Address;