@robosystems/client 0.6.2 → 0.6.3

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "0.6.2",
3
+ "version": "0.6.3",
4
4
  "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -434,7 +434,7 @@ export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = fal
434
434
  /**
435
435
  * Create Repository Subscription
436
436
  *
437
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
437
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
438
438
  */
439
439
  export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError, "fields">;
440
440
  /**
package/sdk/sdk.gen.js CHANGED
@@ -889,7 +889,7 @@ exports.changeSubscriptionPlan = changeSubscriptionPlan;
889
889
  /**
890
890
  * Create Repository Subscription
891
891
  *
892
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
892
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
893
893
  */
894
894
  const createRepositorySubscription = (options) => (options.client ?? client_gen_1.client).post({
895
895
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/sdk/sdk.gen.ts CHANGED
@@ -901,7 +901,7 @@ export const changeSubscriptionPlan = <ThrowOnError extends boolean = false>(opt
901
901
  /**
902
902
  * Create Repository Subscription
903
903
  *
904
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
904
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
905
905
  */
906
906
  export const createRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => (options.client ?? client).post<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>({
907
907
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
@@ -2779,6 +2779,12 @@ export type CreateRepositorySubscriptionRequest = {
2779
2779
  * Plan name for the repository subscription
2780
2780
  */
2781
2781
  plan_name: string;
2782
+ /**
2783
+ * User Id
2784
+ *
2785
+ * Subscribe this user instead of yourself. Org owners and admins only, and the target must belong to the same organization. Omit to subscribe yourself. Repository access is per-user while billing is org-level, so the subscriber is what determines who gets access.
2786
+ */
2787
+ user_id?: string | null;
2782
2788
  };
2783
2789
  /**
2784
2790
  * CreateRollforwardRequest
@@ -5112,12 +5118,24 @@ export type FactRecord = {
5112
5118
  * Element local name
5113
5119
  */
5114
5120
  element_name?: string | null;
5121
+ /**
5122
+ * Period Start
5123
+ *
5124
+ * Period start date (YYYY-MM-DD); null for instant facts. A duration fact is identified by (start, end) — two facts for the same element can share an end date and differ only here (e.g. a quarterly and a year-to-date figure from the same 10-Q).
5125
+ */
5126
+ period_start?: string | null;
5115
5127
  /**
5116
5128
  * Period End
5117
5129
  *
5118
5130
  * Period end date (YYYY-MM-DD)
5119
5131
  */
5120
5132
  period_end?: string | null;
5133
+ /**
5134
+ * Duration Type
5135
+ *
5136
+ * Period duration classification (e.g. 'quarterly', 'nine_months', 'annual'); null for instant facts. Use with period_start to tell overlapping windows apart.
5137
+ */
5138
+ duration_type?: string | null;
5121
5139
  /**
5122
5140
  * Value
5123
5141
  *
@@ -16151,7 +16169,7 @@ export type ViewResponse = {
16151
16169
  /**
16152
16170
  * Summary
16153
16171
  *
16154
- * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants.
16172
+ * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants. Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
16155
16173
  */
16156
16174
  summary?: {
16157
16175
  [key: string]: ElementSummary;
package/sdk/types.gen.ts CHANGED
@@ -2851,6 +2851,12 @@ export type CreateRepositorySubscriptionRequest = {
2851
2851
  * Plan name for the repository subscription
2852
2852
  */
2853
2853
  plan_name: string;
2854
+ /**
2855
+ * User Id
2856
+ *
2857
+ * Subscribe this user instead of yourself. Org owners and admins only, and the target must belong to the same organization. Omit to subscribe yourself. Repository access is per-user while billing is org-level, so the subscriber is what determines who gets access.
2858
+ */
2859
+ user_id?: string | null;
2854
2860
  };
2855
2861
 
2856
2862
  /**
@@ -5244,12 +5250,24 @@ export type FactRecord = {
5244
5250
  * Element local name
5245
5251
  */
5246
5252
  element_name?: string | null;
5253
+ /**
5254
+ * Period Start
5255
+ *
5256
+ * Period start date (YYYY-MM-DD); null for instant facts. A duration fact is identified by (start, end) — two facts for the same element can share an end date and differ only here (e.g. a quarterly and a year-to-date figure from the same 10-Q).
5257
+ */
5258
+ period_start?: string | null;
5247
5259
  /**
5248
5260
  * Period End
5249
5261
  *
5250
5262
  * Period end date (YYYY-MM-DD)
5251
5263
  */
5252
5264
  period_end?: string | null;
5265
+ /**
5266
+ * Duration Type
5267
+ *
5268
+ * Period duration classification (e.g. 'quarterly', 'nine_months', 'annual'); null for instant facts. Use with period_start to tell overlapping windows apart.
5269
+ */
5270
+ duration_type?: string | null;
5253
5271
  /**
5254
5272
  * Value
5255
5273
  *
@@ -16559,7 +16577,7 @@ export type ViewResponse = {
16559
16577
  /**
16560
16578
  * Summary
16561
16579
  *
16562
- * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants.
16580
+ * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants. Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
16563
16581
  */
16564
16582
  summary?: {
16565
16583
  [key: string]: ElementSummary;
package/sdk.gen.d.ts CHANGED
@@ -434,7 +434,7 @@ export declare const changeSubscriptionPlan: <ThrowOnError extends boolean = fal
434
434
  /**
435
435
  * Create Repository Subscription
436
436
  *
437
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
437
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
438
438
  */
439
439
  export declare const createRepositorySubscription: <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => import("./client").RequestResult<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError, "fields">;
440
440
  /**
package/sdk.gen.js CHANGED
@@ -889,7 +889,7 @@ exports.changeSubscriptionPlan = changeSubscriptionPlan;
889
889
  /**
890
890
  * Create Repository Subscription
891
891
  *
892
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
892
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
893
893
  */
894
894
  const createRepositorySubscription = (options) => (options.client ?? client_gen_1.client).post({
895
895
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/sdk.gen.ts CHANGED
@@ -901,7 +901,7 @@ export const changeSubscriptionPlan = <ThrowOnError extends boolean = false>(opt
901
901
  /**
902
902
  * Create Repository Subscription
903
903
  *
904
- * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning.
904
+ * For shared repositories only (sec, industry, etc.). User graph subscriptions are created automatically during provisioning. Subscribes the caller by default; org owners and admins may subscribe another member of their organization by passing `user_id`. Billing is charged to the organization either way — repository access is per-user, so the subscriber determines who receives access.
905
905
  */
906
906
  export const createRepositorySubscription = <ThrowOnError extends boolean = false>(options: Options<CreateRepositorySubscriptionData, ThrowOnError>) => (options.client ?? client).post<CreateRepositorySubscriptionResponses, CreateRepositorySubscriptionErrors, ThrowOnError>({
907
907
  security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
package/types.gen.d.ts CHANGED
@@ -2779,6 +2779,12 @@ export type CreateRepositorySubscriptionRequest = {
2779
2779
  * Plan name for the repository subscription
2780
2780
  */
2781
2781
  plan_name: string;
2782
+ /**
2783
+ * User Id
2784
+ *
2785
+ * Subscribe this user instead of yourself. Org owners and admins only, and the target must belong to the same organization. Omit to subscribe yourself. Repository access is per-user while billing is org-level, so the subscriber is what determines who gets access.
2786
+ */
2787
+ user_id?: string | null;
2782
2788
  };
2783
2789
  /**
2784
2790
  * CreateRollforwardRequest
@@ -5112,12 +5118,24 @@ export type FactRecord = {
5112
5118
  * Element local name
5113
5119
  */
5114
5120
  element_name?: string | null;
5121
+ /**
5122
+ * Period Start
5123
+ *
5124
+ * Period start date (YYYY-MM-DD); null for instant facts. A duration fact is identified by (start, end) — two facts for the same element can share an end date and differ only here (e.g. a quarterly and a year-to-date figure from the same 10-Q).
5125
+ */
5126
+ period_start?: string | null;
5115
5127
  /**
5116
5128
  * Period End
5117
5129
  *
5118
5130
  * Period end date (YYYY-MM-DD)
5119
5131
  */
5120
5132
  period_end?: string | null;
5133
+ /**
5134
+ * Duration Type
5135
+ *
5136
+ * Period duration classification (e.g. 'quarterly', 'nine_months', 'annual'); null for instant facts. Use with period_start to tell overlapping windows apart.
5137
+ */
5138
+ duration_type?: string | null;
5121
5139
  /**
5122
5140
  * Value
5123
5141
  *
@@ -16151,7 +16169,7 @@ export type ViewResponse = {
16151
16169
  /**
16152
16170
  * Summary
16153
16171
  *
16154
- * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants.
16172
+ * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants. Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
16155
16173
  */
16156
16174
  summary?: {
16157
16175
  [key: string]: ElementSummary;
package/types.gen.ts CHANGED
@@ -2851,6 +2851,12 @@ export type CreateRepositorySubscriptionRequest = {
2851
2851
  * Plan name for the repository subscription
2852
2852
  */
2853
2853
  plan_name: string;
2854
+ /**
2855
+ * User Id
2856
+ *
2857
+ * Subscribe this user instead of yourself. Org owners and admins only, and the target must belong to the same organization. Omit to subscribe yourself. Repository access is per-user while billing is org-level, so the subscriber is what determines who gets access.
2858
+ */
2859
+ user_id?: string | null;
2854
2860
  };
2855
2861
 
2856
2862
  /**
@@ -5244,12 +5250,24 @@ export type FactRecord = {
5244
5250
  * Element local name
5245
5251
  */
5246
5252
  element_name?: string | null;
5253
+ /**
5254
+ * Period Start
5255
+ *
5256
+ * Period start date (YYYY-MM-DD); null for instant facts. A duration fact is identified by (start, end) — two facts for the same element can share an end date and differ only here (e.g. a quarterly and a year-to-date figure from the same 10-Q).
5257
+ */
5258
+ period_start?: string | null;
5247
5259
  /**
5248
5260
  * Period End
5249
5261
  *
5250
5262
  * Period end date (YYYY-MM-DD)
5251
5263
  */
5252
5264
  period_end?: string | null;
5265
+ /**
5266
+ * Duration Type
5267
+ *
5268
+ * Period duration classification (e.g. 'quarterly', 'nine_months', 'annual'); null for instant facts. Use with period_start to tell overlapping windows apart.
5269
+ */
5270
+ duration_type?: string | null;
5253
5271
  /**
5254
5272
  * Value
5255
5273
  *
@@ -16559,7 +16577,7 @@ export type ViewResponse = {
16559
16577
  /**
16560
16578
  * Summary
16561
16579
  *
16562
- * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants.
16580
+ * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants. Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
16563
16581
  */
16564
16582
  summary?: {
16565
16583
  [key: string]: ElementSummary;