@salable/sdk 1.0.63 → 1.0.65

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.
@@ -28,6 +28,9 @@ export interface CheckRequestBuilder extends BaseRequestBuilder<CheckRequestBuil
28
28
  */
29
29
  export interface CheckRequestBuilderGetQueryParameters {
30
30
  granteeId?: string;
31
+ /**
32
+ * Owner value to scope the entitlement check to.
33
+ */
31
34
  owner?: string;
32
35
  }
33
36
  /**
@@ -0,0 +1,34 @@
1
+ import { type BatchCreateGranteesRequestSchema, type BatchCreateGranteesResponseSchema } from '../../../models/index.js';
2
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
3
+ /**
4
+ * Builds and executes requests for operations under /api/grantees/batch
5
+ */
6
+ export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuilder> {
7
+ /**
8
+ * Creates up to 500 grantees in a single request. Duplicate granteeIds in the request, grantees that already exist in the organisation, and grantees created concurrently are skipped. For repeated request entries, the first occurrence is used for creation.
9
+ * @param body The request body
10
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
+ * @returns {Promise<BatchCreateGranteesResponseSchema>}
12
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
15
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
17
+ */
18
+ post(body: BatchCreateGranteesRequestSchema[], requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BatchCreateGranteesResponseSchema | undefined>;
19
+ /**
20
+ * Creates up to 500 grantees in a single request. Duplicate granteeIds in the request, grantees that already exist in the organisation, and grantees created concurrently are skipped. For repeated request entries, the first occurrence is used for creation.
21
+ * @param body The request body
22
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
+ * @returns {RequestInformation}
24
+ */
25
+ toPostRequestInformation(body: BatchCreateGranteesRequestSchema[], requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
26
+ }
27
+ /**
28
+ * Uri template for the request builder.
29
+ */
30
+ export declare const BatchRequestBuilderUriTemplate = "{+baseurl}/api/grantees/batch";
31
+ /**
32
+ * Metadata for all the requests in the request builder.
33
+ */
34
+ export declare const BatchRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -1,10 +1,15 @@
1
1
  import { type CreateGranteeRequestSchema, type CreateGranteeResponseSchema, type GetGranteeListSchema } from '../../models/index.js';
2
+ import { type BatchRequestBuilder } from './batch/index.js';
2
3
  import { type GranteesItemRequestBuilder } from './item/index.js';
3
4
  import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
4
5
  /**
5
6
  * Builds and executes requests for operations under /api/grantees
6
7
  */
7
8
  export interface GranteesRequestBuilder extends BaseRequestBuilder<GranteesRequestBuilder> {
9
+ /**
10
+ * The batch property
11
+ */
12
+ get batch(): BatchRequestBuilder;
8
13
  /**
9
14
  * Gets an item from the ApiSdk.api.grantees.item collection
10
15
  * @param id Resource ID
@@ -61,7 +61,7 @@ export interface GroupsRequestBuilderGetQueryParameters {
61
61
  */
62
62
  limit?: string;
63
63
  /**
64
- * Filter by owner ID.
64
+ * Filter by owner ID or value.
65
65
  */
66
66
  owner?: string;
67
67
  /**
@@ -460,7 +460,7 @@ export interface SubscriptionPlansRequestBuilderGetQueryParameters {
460
460
  */
461
461
  limit?: string;
462
462
  /**
463
- * Returns only subscription plans belonging to this owner ID.
463
+ * Returns only subscription plans belonging to this owner ID or value.
464
464
  */
465
465
  owner?: string;
466
466
  /**
@@ -304,7 +304,7 @@ export interface SubscriptionsRequestBuilderGetQueryParameters {
304
304
  */
305
305
  limit?: string;
306
306
  /**
307
- * Returns only subscriptions belonging to this owner ID.
307
+ * Returns only subscriptions belonging to this owner ID or value.
308
308
  */
309
309
  owner?: string;
310
310
  /**
@@ -37,7 +37,7 @@ export interface UsageRecordsRequestBuilderGetQueryParameters {
37
37
  limit?: string;
38
38
  meterSlug?: string;
39
39
  /**
40
- * Owner ID to filter usage records by.
40
+ * Owner ID or value to filter usage records by.
41
41
  */
42
42
  owner?: string;
43
43
  sort?: GetSortQueryParameterType;
@@ -57,6 +57,40 @@ export interface BatchCartActionsResponseSchema_data_results extends Parsable {
57
57
  status?: string | null;
58
58
  }
59
59
  export type BatchCartActionsResponseSchema_data_results_status = string;
60
+ export interface BatchCreateGranteesRequestSchema extends Parsable {
61
+ /**
62
+ * The ID of the entity receiving access in your system, like a user ID or workspace ID.
63
+ */
64
+ granteeId?: string | null;
65
+ /**
66
+ * A readable name to identify the grantee.
67
+ */
68
+ name?: string | null;
69
+ }
70
+ export interface BatchCreateGranteesResponseSchema extends Parsable {
71
+ /**
72
+ * The data property
73
+ */
74
+ data?: BatchCreateGranteesResponseSchema_data | null;
75
+ /**
76
+ * The type property
77
+ */
78
+ type?: string | null;
79
+ }
80
+ export interface BatchCreateGranteesResponseSchema_data extends Parsable {
81
+ /**
82
+ * The number of duplicate or existing grantees that were not created.
83
+ */
84
+ skipped?: number | null;
85
+ /**
86
+ * The number of grantees that were created.
87
+ */
88
+ succeeded?: number | null;
89
+ /**
90
+ * The number of grantees submitted in the request.
91
+ */
92
+ total?: number | null;
93
+ }
60
94
  export interface BatchReceiptActionsRequestSchema extends Parsable {
61
95
  /**
62
96
  * The action property
@@ -317,6 +351,24 @@ export declare function createBatchCartActionsResponseSchema_dataFromDiscriminat
317
351
  * @returns {BatchCartActionsResponseSchema}
318
352
  */
319
353
  export declare function createBatchCartActionsResponseSchemaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
354
+ /**
355
+ * Creates a new instance of the appropriate class based on discriminator value
356
+ * @param parseNode The parse node to use to read the discriminator value and create the object
357
+ * @returns {BatchCreateGranteesRequestSchema}
358
+ */
359
+ export declare function createBatchCreateGranteesRequestSchemaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
360
+ /**
361
+ * Creates a new instance of the appropriate class based on discriminator value
362
+ * @param parseNode The parse node to use to read the discriminator value and create the object
363
+ * @returns {BatchCreateGranteesResponseSchema_data}
364
+ */
365
+ export declare function createBatchCreateGranteesResponseSchema_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
366
+ /**
367
+ * Creates a new instance of the appropriate class based on discriminator value
368
+ * @param parseNode The parse node to use to read the discriminator value and create the object
369
+ * @returns {BatchCreateGranteesResponseSchema}
370
+ */
371
+ export declare function createBatchCreateGranteesResponseSchemaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
320
372
  /**
321
373
  * Creates a new instance of the appropriate class based on discriminator value
322
374
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -2795,11 +2847,11 @@ export declare function createGetWebhookListSchema_dataFromDiscriminatorValue(pa
2795
2847
  export declare function createGetWebhookListSchemaFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
2796
2848
  export interface CreateGranteeRequestSchema extends Parsable {
2797
2849
  /**
2798
- * The granteeId property
2850
+ * The ID of the entity receiving access in your system, like a user ID or workspace ID.
2799
2851
  */
2800
2852
  granteeId?: string | null;
2801
2853
  /**
2802
- * The name property
2854
+ * A readable name to identify the grantee.
2803
2855
  */
2804
2856
  name?: string | null;
2805
2857
  }
@@ -2849,7 +2901,7 @@ export interface CreateGroupRequestSchema extends Parsable {
2849
2901
  */
2850
2902
  name?: string | null;
2851
2903
  /**
2852
- * The owner property
2904
+ * An owner is the tenant a subscription, cart, receipt, or usage record belongs to. Usually a team, organization, or workspace ID, or the user ID for single-user products.
2853
2905
  */
2854
2906
  owner?: string | null;
2855
2907
  }
@@ -3016,7 +3068,7 @@ export interface CreateOwnerRequestSchema extends Parsable {
3016
3068
  */
3017
3069
  name?: string | null;
3018
3070
  /**
3019
- * The value property
3071
+ * The unique value used to identify the owner.
3020
3072
  */
3021
3073
  value?: string | null;
3022
3074
  }
@@ -3708,6 +3760,24 @@ export declare function deserializeIntoBatchCartActionsResponseSchema_data(batch
3708
3760
  * @returns {Record<string, (node: ParseNode) => void>}
3709
3761
  */
3710
3762
  export declare function deserializeIntoBatchCartActionsResponseSchema_data_results(batchCartActionsResponseSchema_data_results?: Partial<BatchCartActionsResponseSchema_data_results> | undefined): Record<string, (node: ParseNode) => void>;
3763
+ /**
3764
+ * The deserialization information for the current model
3765
+ * @param BatchCreateGranteesRequestSchema The instance to deserialize into.
3766
+ * @returns {Record<string, (node: ParseNode) => void>}
3767
+ */
3768
+ export declare function deserializeIntoBatchCreateGranteesRequestSchema(batchCreateGranteesRequestSchema?: Partial<BatchCreateGranteesRequestSchema> | undefined): Record<string, (node: ParseNode) => void>;
3769
+ /**
3770
+ * The deserialization information for the current model
3771
+ * @param BatchCreateGranteesResponseSchema The instance to deserialize into.
3772
+ * @returns {Record<string, (node: ParseNode) => void>}
3773
+ */
3774
+ export declare function deserializeIntoBatchCreateGranteesResponseSchema(batchCreateGranteesResponseSchema?: Partial<BatchCreateGranteesResponseSchema> | undefined): Record<string, (node: ParseNode) => void>;
3775
+ /**
3776
+ * The deserialization information for the current model
3777
+ * @param BatchCreateGranteesResponseSchema_data The instance to deserialize into.
3778
+ * @returns {Record<string, (node: ParseNode) => void>}
3779
+ */
3780
+ export declare function deserializeIntoBatchCreateGranteesResponseSchema_data(batchCreateGranteesResponseSchema_data?: Partial<BatchCreateGranteesResponseSchema_data> | undefined): Record<string, (node: ParseNode) => void>;
3711
3781
  /**
3712
3782
  * The deserialization information for the current model
3713
3783
  * @param BatchReceiptActionsRequestSchema The instance to deserialize into.
@@ -14344,7 +14414,7 @@ export interface RecordUsageRequestSchema extends Parsable {
14344
14414
  */
14345
14415
  meterSlug?: string | null;
14346
14416
  /**
14347
- * The owner property
14417
+ * Owner value to record usage for.
14348
14418
  */
14349
14419
  owner?: string | null;
14350
14420
  }
@@ -14912,6 +14982,27 @@ export declare function serializeBatchCartActionsResponseSchema_data_results(wri
14912
14982
  * @param writer Serialization writer to use to serialize this model
14913
14983
  */
14914
14984
  export declare function serializeBatchCartActionsResponseSchema_data_results_status(writer: SerializationWriter, key: string, batchCartActionsResponseSchema_data_results_status: Parsable | BatchCartActionsResponseSchema_data_results_status | undefined, isSerializingDerivedType?: boolean): void;
14985
+ /**
14986
+ * Serializes information the current object
14987
+ * @param BatchCreateGranteesRequestSchema The instance to serialize from.
14988
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
14989
+ * @param writer Serialization writer to use to serialize this model
14990
+ */
14991
+ export declare function serializeBatchCreateGranteesRequestSchema(writer: SerializationWriter, batchCreateGranteesRequestSchema?: Partial<BatchCreateGranteesRequestSchema> | undefined | null, isSerializingDerivedType?: boolean): void;
14992
+ /**
14993
+ * Serializes information the current object
14994
+ * @param BatchCreateGranteesResponseSchema The instance to serialize from.
14995
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
14996
+ * @param writer Serialization writer to use to serialize this model
14997
+ */
14998
+ export declare function serializeBatchCreateGranteesResponseSchema(writer: SerializationWriter, batchCreateGranteesResponseSchema?: Partial<BatchCreateGranteesResponseSchema> | undefined | null, isSerializingDerivedType?: boolean): void;
14999
+ /**
15000
+ * Serializes information the current object
15001
+ * @param BatchCreateGranteesResponseSchema_data The instance to serialize from.
15002
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
15003
+ * @param writer Serialization writer to use to serialize this model
15004
+ */
15005
+ export declare function serializeBatchCreateGranteesResponseSchema_data(writer: SerializationWriter, batchCreateGranteesResponseSchema_data?: Partial<BatchCreateGranteesResponseSchema_data> | undefined | null, isSerializingDerivedType?: boolean): void;
14915
15006
  /**
14916
15007
  * Serializes information the current object
14917
15008
  * @param BatchReceiptActionsRequestSchema The instance to serialize from.
@@ -18057,7 +18148,7 @@ export interface UpdateCartRequestSchema extends Parsable {
18057
18148
  */
18058
18149
  currency?: string | UpdateCartRequestSchema_currencyMember1 | null;
18059
18150
  /**
18060
- * The owner property
18151
+ * An owner is the tenant a subscription, cart, receipt, or usage record belongs to. Usually a team, organization, or workspace ID, or the user ID for single-user products.
18061
18152
  */
18062
18153
  owner?: string | null;
18063
18154
  }
@@ -18418,7 +18509,7 @@ export interface UpdateOwnerRequestSchema extends Parsable {
18418
18509
  */
18419
18510
  owner?: string | null;
18420
18511
  /**
18421
- * The value property
18512
+ * The unique value used to identify the owner.
18422
18513
  */
18423
18514
  value?: string | null;
18424
18515
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salable/sdk",
3
- "version": "1.0.63",
3
+ "version": "1.0.65",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.es.js",