diff --git a/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md index fcd14db0d..e976f171f 100644 --- a/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/Beta/Methods/SuggestedEntitlementDescriptionAPI.md @@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Record [**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions [**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description [**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request @@ -98,24 +98,32 @@ func main() { [[Back to top]](#) ## get-sed-batches -List sed batch request +List Sed Batch Record List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches) ### Path Parameters -This endpoint does not need any parameter. + ### Other Parameters Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **count** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | [default to false] + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [default to false] + **status** | **string** | Batch Status | + ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**[]Sed**](../models/sed) ### HTTP request headers @@ -137,18 +145,23 @@ import ( ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []Sed fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } ``` @@ -507,7 +520,30 @@ import ( func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional) diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteria.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteria.md new file mode 100644 index 000000000..edbe8bb3c --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteria.md @@ -0,0 +1,241 @@ +--- +id: beta-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteria', 'BetaSearchCriteria'] +slug: /tools/sdk/go/beta/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'BetaSearchCriteria'] +--- + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]string** | A list of indices to search within. Must contain exactly one item, typically \"entitlements\". | +**Filters** | Pointer to [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | Pointer to [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | Pointer to **string** | Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. | [optional] +**TextQuery** | Pointer to [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Whether to include nested objects in the search results. | [optional] [default to false] +**Sort** | Pointer to **[]string** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | Pointer to **[]string** | Used for pagination to fetch results after a specific point. | [optional] + +## Methods + +### NewSearchCriteria + +`func NewSearchCriteria(indices []string, ) *SearchCriteria` + +NewSearchCriteria instantiates a new SearchCriteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaWithDefaults + +`func NewSearchCriteriaWithDefaults() *SearchCriteria` + +NewSearchCriteriaWithDefaults instantiates a new SearchCriteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIndices + +`func (o *SearchCriteria) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchCriteria) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchCriteria) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + + +### GetFilters + +`func (o *SearchCriteria) GetFilters() map[string]SearchCriteriaFiltersValue` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SearchCriteria) GetFiltersOk() (*map[string]SearchCriteriaFiltersValue, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SearchCriteria) SetFilters(v map[string]SearchCriteriaFiltersValue)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SearchCriteria) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchCriteria) GetQuery() SearchCriteriaQuery` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteria) GetQueryOk() (*SearchCriteriaQuery, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteria) SetQuery(v SearchCriteriaQuery)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteria) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryType + +`func (o *SearchCriteria) GetQueryType() string` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *SearchCriteria) GetQueryTypeOk() (*string, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *SearchCriteria) SetQueryType(v string)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *SearchCriteria) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *SearchCriteria) GetTextQuery() SearchCriteriaTextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *SearchCriteria) GetTextQueryOk() (*SearchCriteriaTextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *SearchCriteria) SetTextQuery(v SearchCriteriaTextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *SearchCriteria) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *SearchCriteria) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *SearchCriteria) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *SearchCriteria) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *SearchCriteria) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchCriteria) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchCriteria) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchCriteria) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchCriteria) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *SearchCriteria) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *SearchCriteria) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *SearchCriteria) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *SearchCriteria) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..34ce83a18 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,116 @@ +--- +id: beta-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue'] +slug: /tools/sdk/go/beta/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue'] +--- + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of filter, e.g., \"TERMS\" or \"RANGE\". | [optional] +**Terms** | Pointer to **[]string** | Terms to filter by (for \"TERMS\" type). | [optional] +**Range** | Pointer to [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValue + +`func NewSearchCriteriaFiltersValue() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValue instantiates a new SearchCriteriaFiltersValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueWithDefaults + +`func NewSearchCriteriaFiltersValueWithDefaults() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValueWithDefaults instantiates a new SearchCriteriaFiltersValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *SearchCriteriaFiltersValue) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchCriteriaFiltersValue) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchCriteriaFiltersValue) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SearchCriteriaFiltersValue) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTerms + +`func (o *SearchCriteriaFiltersValue) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaFiltersValue) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaFiltersValue) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaFiltersValue) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetRange + +`func (o *SearchCriteriaFiltersValue) GetRange() SearchCriteriaFiltersValueRange` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SearchCriteriaFiltersValue) GetRangeOk() (*SearchCriteriaFiltersValueRange, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SearchCriteriaFiltersValue) SetRange(v SearchCriteriaFiltersValueRange)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SearchCriteriaFiltersValue) HasRange() bool` + +HasRange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..e82d4653f --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,90 @@ +--- +id: beta-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange'] +slug: /tools/sdk/go/beta/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange'] +--- + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | Pointer to [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValueRange + +`func NewSearchCriteriaFiltersValueRange() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRange instantiates a new SearchCriteriaFiltersValueRange object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeWithDefaults + +`func NewSearchCriteriaFiltersValueRangeWithDefaults() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRangeWithDefaults instantiates a new SearchCriteriaFiltersValueRange object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLower + +`func (o *SearchCriteriaFiltersValueRange) GetLower() SearchCriteriaFiltersValueRangeLower` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *SearchCriteriaFiltersValueRange) GetLowerOk() (*SearchCriteriaFiltersValueRangeLower, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *SearchCriteriaFiltersValueRange) SetLower(v SearchCriteriaFiltersValueRangeLower)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *SearchCriteriaFiltersValueRange) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *SearchCriteriaFiltersValueRange) GetUpper() SearchCriteriaFiltersValueRangeUpper` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *SearchCriteriaFiltersValueRange) GetUpperOk() (*SearchCriteriaFiltersValueRangeUpper, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *SearchCriteriaFiltersValueRange) SetUpper(v SearchCriteriaFiltersValueRangeUpper)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *SearchCriteriaFiltersValueRange) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..2d3b193f0 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,90 @@ +--- +id: beta-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/go/beta/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower'] +--- + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The lower bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the lower bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeLower + +`func NewSearchCriteriaFiltersValueRangeLower() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLower instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeLowerWithDefaults + +`func NewSearchCriteriaFiltersValueRangeLowerWithDefaults() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLowerWithDefaults instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeLower) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..f3a827af8 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,90 @@ +--- +id: beta-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/go/beta/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper'] +--- + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The upper bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the upper bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeUpper + +`func NewSearchCriteriaFiltersValueRangeUpper() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpper instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeUpperWithDefaults + +`func NewSearchCriteriaFiltersValueRangeUpperWithDefaults() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpperWithDefaults instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaQuery.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..e71fce260 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaQuery.md @@ -0,0 +1,64 @@ +--- +id: beta-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery'] +slug: /tools/sdk/go/beta/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery'] +--- + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | A structured query for advanced search. | [optional] + +## Methods + +### NewSearchCriteriaQuery + +`func NewSearchCriteriaQuery() *SearchCriteriaQuery` + +NewSearchCriteriaQuery instantiates a new SearchCriteriaQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaQueryWithDefaults + +`func NewSearchCriteriaQueryWithDefaults() *SearchCriteriaQuery` + +NewSearchCriteriaQueryWithDefaults instantiates a new SearchCriteriaQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuery + +`func (o *SearchCriteriaQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteriaQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteriaQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteriaQuery) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..5e157f831 --- /dev/null +++ b/docs/tools/sdk/go/Reference/Beta/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,116 @@ +--- +id: beta-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery'] +slug: /tools/sdk/go/beta/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery'] +--- + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | Pointer to **[]string** | Terms to search for. | [optional] +**Fields** | Pointer to **[]string** | Fields to search within. | [optional] +**MatchAny** | Pointer to **bool** | Whether to match any of the terms. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaTextQuery + +`func NewSearchCriteriaTextQuery() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQuery instantiates a new SearchCriteriaTextQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaTextQueryWithDefaults + +`func NewSearchCriteriaTextQueryWithDefaults() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQueryWithDefaults instantiates a new SearchCriteriaTextQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTerms + +`func (o *SearchCriteriaTextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaTextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaTextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaTextQuery) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetFields + +`func (o *SearchCriteriaTextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SearchCriteriaTextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SearchCriteriaTextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SearchCriteriaTextQuery) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetMatchAny + +`func (o *SearchCriteriaTextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *SearchCriteriaTextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *SearchCriteriaTextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *SearchCriteriaTextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md index 987c011ad..964e44627 100644 --- a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md +++ b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchRequest.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] **Seds** | Pointer to **[]string** | list of sed ids | [optional] +**SearchCriteria** | Pointer to [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Methods @@ -62,6 +63,16 @@ SetEntitlements sets Entitlements field to given value. HasEntitlements returns a boolean if a field has been set. +### SetEntitlementsNil + +`func (o *SedBatchRequest) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *SedBatchRequest) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil ### GetSeds `func (o *SedBatchRequest) GetSeds() []string` @@ -87,4 +98,49 @@ SetSeds sets Seds field to given value. HasSeds returns a boolean if a field has been set. +### SetSedsNil + +`func (o *SedBatchRequest) SetSedsNil(b bool)` + + SetSedsNil sets the value for Seds to be an explicit nil + +### UnsetSeds +`func (o *SedBatchRequest) UnsetSeds()` + +UnsetSeds ensures that no value is present for Seds, not even an explicit nil +### GetSearchCriteria + +`func (o *SedBatchRequest) GetSearchCriteria() map[string]SearchCriteria` + +GetSearchCriteria returns the SearchCriteria field if non-nil, zero value otherwise. + +### GetSearchCriteriaOk + +`func (o *SedBatchRequest) GetSearchCriteriaOk() (*map[string]SearchCriteria, bool)` + +GetSearchCriteriaOk returns a tuple with the SearchCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCriteria + +`func (o *SedBatchRequest) SetSearchCriteria(v map[string]SearchCriteria)` + +SetSearchCriteria sets SearchCriteria field to given value. + +### HasSearchCriteria + +`func (o *SedBatchRequest) HasSearchCriteria() bool` + +HasSearchCriteria returns a boolean if a field has been set. + +### SetSearchCriteriaNil + +`func (o *SedBatchRequest) SetSearchCriteriaNil(b bool)` + + SetSearchCriteriaNil sets the value for SearchCriteria to be an explicit nil + +### UnsetSearchCriteria +`func (o *SedBatchRequest) UnsetSearchCriteria()` + +UnsetSearchCriteria ensures that no value is present for SearchCriteria, not even an explicit nil diff --git a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md deleted file mode 100644 index be2a00587..000000000 --- a/docs/tools/sdk/go/Reference/Beta/Models/SedBatchStatus.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: beta-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: gosdk -keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus'] -slug: /tools/sdk/go/beta/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus'] ---- - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **string** | status of batch | [optional] - -## Methods - -### NewSedBatchStatus - -`func NewSedBatchStatus() *SedBatchStatus` - -NewSedBatchStatus instantiates a new SedBatchStatus object -This constructor will assign default values to properties that have it defined, -and makes sure properties required by API are set, but the set of arguments -will change when the set of required properties is changed - -### NewSedBatchStatusWithDefaults - -`func NewSedBatchStatusWithDefaults() *SedBatchStatus` - -NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus object -This constructor will only assign default values to properties that have it defined, -but it doesn't guarantee that properties required by API are set - -### GetStatus - -`func (o *SedBatchStatus) GetStatus() string` - -GetStatus returns the Status field if non-nil, zero value otherwise. - -### GetStatusOk - -`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` - -GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetStatus - -`func (o *SedBatchStatus) SetStatus(v string)` - -SetStatus sets Status field to given value. - -### HasStatus - -`func (o *SedBatchStatus) HasStatus() bool` - -HasStatus returns a boolean if a field has been set. - - diff --git a/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md index 710785661..11fe06207 100644 --- a/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/V2024/Methods/SuggestedEntitlementDescriptionAPI.md @@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Record [**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions [**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description [**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request @@ -98,24 +98,32 @@ func main() { [[Back to top]](#) ## get-sed-batches -List sed batch request +List Sed Batch Record List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches) ### Path Parameters -This endpoint does not need any parameter. + ### Other Parameters Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **count** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | [default to false] + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. | [default to false] + **status** | **string** | Batch Status | + ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**[]SedBatchRecord**](../models/sed-batch-record) ### HTTP request headers @@ -137,18 +145,23 @@ import ( ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []SedBatchRecord fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } ``` @@ -506,7 +519,30 @@ import ( func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional) diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteria.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteria.md new file mode 100644 index 000000000..4e6e8e51f --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteria.md @@ -0,0 +1,241 @@ +--- +id: v2024-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteria', 'V2024SearchCriteria'] +slug: /tools/sdk/go/v2024/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2024SearchCriteria'] +--- + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]string** | A list of indices to search within. Must contain exactly one item, typically \"entitlements\". | +**Filters** | Pointer to [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | Pointer to [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | Pointer to **string** | Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. | [optional] +**TextQuery** | Pointer to [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Whether to include nested objects in the search results. | [optional] [default to false] +**Sort** | Pointer to **[]string** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | Pointer to **[]string** | Used for pagination to fetch results after a specific point. | [optional] + +## Methods + +### NewSearchCriteria + +`func NewSearchCriteria(indices []string, ) *SearchCriteria` + +NewSearchCriteria instantiates a new SearchCriteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaWithDefaults + +`func NewSearchCriteriaWithDefaults() *SearchCriteria` + +NewSearchCriteriaWithDefaults instantiates a new SearchCriteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIndices + +`func (o *SearchCriteria) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchCriteria) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchCriteria) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + + +### GetFilters + +`func (o *SearchCriteria) GetFilters() map[string]SearchCriteriaFiltersValue` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SearchCriteria) GetFiltersOk() (*map[string]SearchCriteriaFiltersValue, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SearchCriteria) SetFilters(v map[string]SearchCriteriaFiltersValue)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SearchCriteria) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchCriteria) GetQuery() SearchCriteriaQuery` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteria) GetQueryOk() (*SearchCriteriaQuery, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteria) SetQuery(v SearchCriteriaQuery)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteria) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryType + +`func (o *SearchCriteria) GetQueryType() string` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *SearchCriteria) GetQueryTypeOk() (*string, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *SearchCriteria) SetQueryType(v string)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *SearchCriteria) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *SearchCriteria) GetTextQuery() SearchCriteriaTextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *SearchCriteria) GetTextQueryOk() (*SearchCriteriaTextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *SearchCriteria) SetTextQuery(v SearchCriteriaTextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *SearchCriteria) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *SearchCriteria) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *SearchCriteria) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *SearchCriteria) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *SearchCriteria) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchCriteria) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchCriteria) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchCriteria) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchCriteria) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *SearchCriteria) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *SearchCriteria) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *SearchCriteria) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *SearchCriteria) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..52b91a9d2 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,116 @@ +--- +id: v2024-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue'] +slug: /tools/sdk/go/v2024/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue'] +--- + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of filter, e.g., \"TERMS\" or \"RANGE\". | [optional] +**Terms** | Pointer to **[]string** | Terms to filter by (for \"TERMS\" type). | [optional] +**Range** | Pointer to [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValue + +`func NewSearchCriteriaFiltersValue() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValue instantiates a new SearchCriteriaFiltersValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueWithDefaults + +`func NewSearchCriteriaFiltersValueWithDefaults() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValueWithDefaults instantiates a new SearchCriteriaFiltersValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *SearchCriteriaFiltersValue) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchCriteriaFiltersValue) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchCriteriaFiltersValue) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SearchCriteriaFiltersValue) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTerms + +`func (o *SearchCriteriaFiltersValue) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaFiltersValue) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaFiltersValue) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaFiltersValue) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetRange + +`func (o *SearchCriteriaFiltersValue) GetRange() SearchCriteriaFiltersValueRange` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SearchCriteriaFiltersValue) GetRangeOk() (*SearchCriteriaFiltersValueRange, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SearchCriteriaFiltersValue) SetRange(v SearchCriteriaFiltersValueRange)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SearchCriteriaFiltersValue) HasRange() bool` + +HasRange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..813ed916e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,90 @@ +--- +id: v2024-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange'] +slug: /tools/sdk/go/v2024/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange'] +--- + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | Pointer to [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValueRange + +`func NewSearchCriteriaFiltersValueRange() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRange instantiates a new SearchCriteriaFiltersValueRange object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeWithDefaults + +`func NewSearchCriteriaFiltersValueRangeWithDefaults() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRangeWithDefaults instantiates a new SearchCriteriaFiltersValueRange object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLower + +`func (o *SearchCriteriaFiltersValueRange) GetLower() SearchCriteriaFiltersValueRangeLower` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *SearchCriteriaFiltersValueRange) GetLowerOk() (*SearchCriteriaFiltersValueRangeLower, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *SearchCriteriaFiltersValueRange) SetLower(v SearchCriteriaFiltersValueRangeLower)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *SearchCriteriaFiltersValueRange) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *SearchCriteriaFiltersValueRange) GetUpper() SearchCriteriaFiltersValueRangeUpper` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *SearchCriteriaFiltersValueRange) GetUpperOk() (*SearchCriteriaFiltersValueRangeUpper, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *SearchCriteriaFiltersValueRange) SetUpper(v SearchCriteriaFiltersValueRangeUpper)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *SearchCriteriaFiltersValueRange) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..fc6085fdd --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,90 @@ +--- +id: v2024-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/go/v2024/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower'] +--- + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The lower bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the lower bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeLower + +`func NewSearchCriteriaFiltersValueRangeLower() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLower instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeLowerWithDefaults + +`func NewSearchCriteriaFiltersValueRangeLowerWithDefaults() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLowerWithDefaults instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeLower) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..f1e32cb26 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,90 @@ +--- +id: v2024-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/go/v2024/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper'] +--- + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The upper bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the upper bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeUpper + +`func NewSearchCriteriaFiltersValueRangeUpper() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpper instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeUpperWithDefaults + +`func NewSearchCriteriaFiltersValueRangeUpperWithDefaults() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpperWithDefaults instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaQuery.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..5d80036ce --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaQuery.md @@ -0,0 +1,64 @@ +--- +id: v2024-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery'] +slug: /tools/sdk/go/v2024/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery'] +--- + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | A structured query for advanced search. | [optional] + +## Methods + +### NewSearchCriteriaQuery + +`func NewSearchCriteriaQuery() *SearchCriteriaQuery` + +NewSearchCriteriaQuery instantiates a new SearchCriteriaQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaQueryWithDefaults + +`func NewSearchCriteriaQueryWithDefaults() *SearchCriteriaQuery` + +NewSearchCriteriaQueryWithDefaults instantiates a new SearchCriteriaQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuery + +`func (o *SearchCriteriaQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteriaQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteriaQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteriaQuery) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..e79bdc069 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,116 @@ +--- +id: v2024-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery'] +slug: /tools/sdk/go/v2024/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery'] +--- + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | Pointer to **[]string** | Terms to search for. | [optional] +**Fields** | Pointer to **[]string** | Fields to search within. | [optional] +**MatchAny** | Pointer to **bool** | Whether to match any of the terms. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaTextQuery + +`func NewSearchCriteriaTextQuery() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQuery instantiates a new SearchCriteriaTextQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaTextQueryWithDefaults + +`func NewSearchCriteriaTextQueryWithDefaults() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQueryWithDefaults instantiates a new SearchCriteriaTextQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTerms + +`func (o *SearchCriteriaTextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaTextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaTextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaTextQuery) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetFields + +`func (o *SearchCriteriaTextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SearchCriteriaTextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SearchCriteriaTextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SearchCriteriaTextQuery) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetMatchAny + +`func (o *SearchCriteriaTextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *SearchCriteriaTextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *SearchCriteriaTextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *SearchCriteriaTextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRecord.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRecord.md new file mode 100644 index 000000000..311ebe58e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRecord.md @@ -0,0 +1,302 @@ +--- +id: v2024-sed-batch-record +title: SedBatchRecord +pagination_label: SedBatchRecord +sidebar_label: SedBatchRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchRecord', 'V2024SedBatchRecord'] +slug: /tools/sdk/go/v2024/models/sed-batch-record +tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2024SedBatchRecord'] +--- + +# SedBatchRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TenantId** | Pointer to **string** | The tenant ID associated with the batch. | [optional] +**BatchId** | Pointer to **string** | The unique ID of the batch. | [optional] +**Name** | Pointer to **NullableString** | The name of the batch. | [optional] +**ProcessedState** | Pointer to **NullableString** | The current state of the batch (e.g., submitted, materialized, completed). | [optional] +**RequestedBy** | Pointer to **string** | The ID of the user who requested the batch. | [optional] +**MaterializedCount** | Pointer to **int32** | The number of items materialized in the batch. | [optional] +**ProcessedCount** | Pointer to **int32** | The number of items processed in the batch. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the batch was created. | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The timestamp when the batch was last updated. | [optional] + +## Methods + +### NewSedBatchRecord + +`func NewSedBatchRecord() *SedBatchRecord` + +NewSedBatchRecord instantiates a new SedBatchRecord object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSedBatchRecordWithDefaults + +`func NewSedBatchRecordWithDefaults() *SedBatchRecord` + +NewSedBatchRecordWithDefaults instantiates a new SedBatchRecord object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTenantId + +`func (o *SedBatchRecord) GetTenantId() string` + +GetTenantId returns the TenantId field if non-nil, zero value otherwise. + +### GetTenantIdOk + +`func (o *SedBatchRecord) GetTenantIdOk() (*string, bool)` + +GetTenantIdOk returns a tuple with the TenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantId + +`func (o *SedBatchRecord) SetTenantId(v string)` + +SetTenantId sets TenantId field to given value. + +### HasTenantId + +`func (o *SedBatchRecord) HasTenantId() bool` + +HasTenantId returns a boolean if a field has been set. + +### GetBatchId + +`func (o *SedBatchRecord) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchRecord) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchRecord) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchRecord) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetName + +`func (o *SedBatchRecord) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SedBatchRecord) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SedBatchRecord) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SedBatchRecord) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *SedBatchRecord) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SedBatchRecord) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetProcessedState + +`func (o *SedBatchRecord) GetProcessedState() string` + +GetProcessedState returns the ProcessedState field if non-nil, zero value otherwise. + +### GetProcessedStateOk + +`func (o *SedBatchRecord) GetProcessedStateOk() (*string, bool)` + +GetProcessedStateOk returns a tuple with the ProcessedState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedState + +`func (o *SedBatchRecord) SetProcessedState(v string)` + +SetProcessedState sets ProcessedState field to given value. + +### HasProcessedState + +`func (o *SedBatchRecord) HasProcessedState() bool` + +HasProcessedState returns a boolean if a field has been set. + +### SetProcessedStateNil + +`func (o *SedBatchRecord) SetProcessedStateNil(b bool)` + + SetProcessedStateNil sets the value for ProcessedState to be an explicit nil + +### UnsetProcessedState +`func (o *SedBatchRecord) UnsetProcessedState()` + +UnsetProcessedState ensures that no value is present for ProcessedState, not even an explicit nil +### GetRequestedBy + +`func (o *SedBatchRecord) GetRequestedBy() string` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *SedBatchRecord) GetRequestedByOk() (*string, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *SedBatchRecord) SetRequestedBy(v string)` + +SetRequestedBy sets RequestedBy field to given value. + +### HasRequestedBy + +`func (o *SedBatchRecord) HasRequestedBy() bool` + +HasRequestedBy returns a boolean if a field has been set. + +### GetMaterializedCount + +`func (o *SedBatchRecord) GetMaterializedCount() int32` + +GetMaterializedCount returns the MaterializedCount field if non-nil, zero value otherwise. + +### GetMaterializedCountOk + +`func (o *SedBatchRecord) GetMaterializedCountOk() (*int32, bool)` + +GetMaterializedCountOk returns a tuple with the MaterializedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaterializedCount + +`func (o *SedBatchRecord) SetMaterializedCount(v int32)` + +SetMaterializedCount sets MaterializedCount field to given value. + +### HasMaterializedCount + +`func (o *SedBatchRecord) HasMaterializedCount() bool` + +HasMaterializedCount returns a boolean if a field has been set. + +### GetProcessedCount + +`func (o *SedBatchRecord) GetProcessedCount() int32` + +GetProcessedCount returns the ProcessedCount field if non-nil, zero value otherwise. + +### GetProcessedCountOk + +`func (o *SedBatchRecord) GetProcessedCountOk() (*int32, bool)` + +GetProcessedCountOk returns a tuple with the ProcessedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedCount + +`func (o *SedBatchRecord) SetProcessedCount(v int32)` + +SetProcessedCount sets ProcessedCount field to given value. + +### HasProcessedCount + +`func (o *SedBatchRecord) HasProcessedCount() bool` + +HasProcessedCount returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SedBatchRecord) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SedBatchRecord) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SedBatchRecord) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SedBatchRecord) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *SedBatchRecord) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *SedBatchRecord) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *SedBatchRecord) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *SedBatchRecord) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *SedBatchRecord) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *SedBatchRecord) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md index 0174957bf..e88bc8d00 100644 --- a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md +++ b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchRequest.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] **Seds** | Pointer to **[]string** | list of sed ids | [optional] +**SearchCriteria** | Pointer to [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Methods @@ -62,6 +63,16 @@ SetEntitlements sets Entitlements field to given value. HasEntitlements returns a boolean if a field has been set. +### SetEntitlementsNil + +`func (o *SedBatchRequest) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *SedBatchRequest) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil ### GetSeds `func (o *SedBatchRequest) GetSeds() []string` @@ -87,4 +98,49 @@ SetSeds sets Seds field to given value. HasSeds returns a boolean if a field has been set. +### SetSedsNil + +`func (o *SedBatchRequest) SetSedsNil(b bool)` + + SetSedsNil sets the value for Seds to be an explicit nil + +### UnsetSeds +`func (o *SedBatchRequest) UnsetSeds()` + +UnsetSeds ensures that no value is present for Seds, not even an explicit nil +### GetSearchCriteria + +`func (o *SedBatchRequest) GetSearchCriteria() map[string]SearchCriteria` + +GetSearchCriteria returns the SearchCriteria field if non-nil, zero value otherwise. + +### GetSearchCriteriaOk + +`func (o *SedBatchRequest) GetSearchCriteriaOk() (*map[string]SearchCriteria, bool)` + +GetSearchCriteriaOk returns a tuple with the SearchCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCriteria + +`func (o *SedBatchRequest) SetSearchCriteria(v map[string]SearchCriteria)` + +SetSearchCriteria sets SearchCriteria field to given value. + +### HasSearchCriteria + +`func (o *SedBatchRequest) HasSearchCriteria() bool` + +HasSearchCriteria returns a boolean if a field has been set. + +### SetSearchCriteriaNil + +`func (o *SedBatchRequest) SetSearchCriteriaNil(b bool)` + + SetSearchCriteriaNil sets the value for SearchCriteria to be an explicit nil + +### UnsetSearchCriteria +`func (o *SedBatchRequest) UnsetSearchCriteria()` + +UnsetSearchCriteria ensures that no value is present for SearchCriteria, not even an explicit nil diff --git a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md deleted file mode 100644 index 8bc414aad..000000000 --- a/docs/tools/sdk/go/Reference/V2024/Models/SedBatchStatus.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: v2024-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: gosdk -keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus'] -slug: /tools/sdk/go/v2024/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus'] ---- - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **string** | status of batch | [optional] - -## Methods - -### NewSedBatchStatus - -`func NewSedBatchStatus() *SedBatchStatus` - -NewSedBatchStatus instantiates a new SedBatchStatus object -This constructor will assign default values to properties that have it defined, -and makes sure properties required by API are set, but the set of arguments -will change when the set of required properties is changed - -### NewSedBatchStatusWithDefaults - -`func NewSedBatchStatusWithDefaults() *SedBatchStatus` - -NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus object -This constructor will only assign default values to properties that have it defined, -but it doesn't guarantee that properties required by API are set - -### GetStatus - -`func (o *SedBatchStatus) GetStatus() string` - -GetStatus returns the Status field if non-nil, zero value otherwise. - -### GetStatusOk - -`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` - -GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetStatus - -`func (o *SedBatchStatus) SetStatus(v string)` - -SetStatus sets Status field to given value. - -### HasStatus - -`func (o *SedBatchStatus) HasStatus() bool` - -HasStatus returns a boolean if a field has been set. - - diff --git a/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md index ba82299d4..15db4b999 100644 --- a/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md +++ b/docs/tools/sdk/go/Reference/V2025/Methods/SuggestedEntitlementDescriptionAPI.md @@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**get-sed-batch-stats**](#get-sed-batch-stats) | **Get** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request -[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List sed batch request +[**get-sed-batches**](#get-sed-batches) | **Get** `/suggested-entitlement-description-batches` | List Sed Batch Record [**list-seds**](#list-seds) | **Get** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions [**patch-sed**](#patch-sed) | **Patch** `/suggested-entitlement-descriptions` | Patch suggested entitlement description [**submit-sed-approval**](#submit-sed-approval) | **Post** `/suggested-entitlement-description-approvals` | Submit bulk approval request @@ -98,24 +98,32 @@ func main() { [[Back to top]](#) ## get-sed-batches -List sed batch request +List Sed Batch Record List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sed-batches) ### Path Parameters -This endpoint does not need any parameter. + ### Other Parameters Other parameters are passed through a pointer to a apiGetSedBatchesRequest struct via the builder pattern +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **offset** | **int64** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [default to 0] + **limit** | **int64** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [default to 250] + **count** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | [default to false] + **countOnly** | **bool** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [default to false] + **status** | **string** | Batch Status | + ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**[]SedBatchRecord**](../models/sed-batch-record) ### HTTP request headers @@ -137,18 +145,23 @@ import ( ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []SedBatchRecord fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } ``` @@ -506,7 +519,30 @@ import ( func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional) diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteria.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteria.md new file mode 100644 index 000000000..8f3cb14a9 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteria.md @@ -0,0 +1,241 @@ +--- +id: v2025-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteria', 'V2025SearchCriteria'] +slug: /tools/sdk/go/v2025/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2025SearchCriteria'] +--- + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]string** | A list of indices to search within. Must contain exactly one item, typically \"entitlements\". | +**Filters** | Pointer to [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | Pointer to [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | Pointer to **string** | Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. | [optional] +**TextQuery** | Pointer to [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | Pointer to **bool** | Whether to include nested objects in the search results. | [optional] [default to false] +**Sort** | Pointer to **[]string** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | Pointer to **[]string** | Used for pagination to fetch results after a specific point. | [optional] + +## Methods + +### NewSearchCriteria + +`func NewSearchCriteria(indices []string, ) *SearchCriteria` + +NewSearchCriteria instantiates a new SearchCriteria object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaWithDefaults + +`func NewSearchCriteriaWithDefaults() *SearchCriteria` + +NewSearchCriteriaWithDefaults instantiates a new SearchCriteria object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIndices + +`func (o *SearchCriteria) GetIndices() []string` + +GetIndices returns the Indices field if non-nil, zero value otherwise. + +### GetIndicesOk + +`func (o *SearchCriteria) GetIndicesOk() (*[]string, bool)` + +GetIndicesOk returns a tuple with the Indices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIndices + +`func (o *SearchCriteria) SetIndices(v []string)` + +SetIndices sets Indices field to given value. + + +### GetFilters + +`func (o *SearchCriteria) GetFilters() map[string]SearchCriteriaFiltersValue` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *SearchCriteria) GetFiltersOk() (*map[string]SearchCriteriaFiltersValue, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilters + +`func (o *SearchCriteria) SetFilters(v map[string]SearchCriteriaFiltersValue)` + +SetFilters sets Filters field to given value. + +### HasFilters + +`func (o *SearchCriteria) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### GetQuery + +`func (o *SearchCriteria) GetQuery() SearchCriteriaQuery` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteria) GetQueryOk() (*SearchCriteriaQuery, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteria) SetQuery(v SearchCriteriaQuery)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteria) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + +### GetQueryType + +`func (o *SearchCriteria) GetQueryType() string` + +GetQueryType returns the QueryType field if non-nil, zero value otherwise. + +### GetQueryTypeOk + +`func (o *SearchCriteria) GetQueryTypeOk() (*string, bool)` + +GetQueryTypeOk returns a tuple with the QueryType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQueryType + +`func (o *SearchCriteria) SetQueryType(v string)` + +SetQueryType sets QueryType field to given value. + +### HasQueryType + +`func (o *SearchCriteria) HasQueryType() bool` + +HasQueryType returns a boolean if a field has been set. + +### GetTextQuery + +`func (o *SearchCriteria) GetTextQuery() SearchCriteriaTextQuery` + +GetTextQuery returns the TextQuery field if non-nil, zero value otherwise. + +### GetTextQueryOk + +`func (o *SearchCriteria) GetTextQueryOk() (*SearchCriteriaTextQuery, bool)` + +GetTextQueryOk returns a tuple with the TextQuery field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTextQuery + +`func (o *SearchCriteria) SetTextQuery(v SearchCriteriaTextQuery)` + +SetTextQuery sets TextQuery field to given value. + +### HasTextQuery + +`func (o *SearchCriteria) HasTextQuery() bool` + +HasTextQuery returns a boolean if a field has been set. + +### GetIncludeNested + +`func (o *SearchCriteria) GetIncludeNested() bool` + +GetIncludeNested returns the IncludeNested field if non-nil, zero value otherwise. + +### GetIncludeNestedOk + +`func (o *SearchCriteria) GetIncludeNestedOk() (*bool, bool)` + +GetIncludeNestedOk returns a tuple with the IncludeNested field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIncludeNested + +`func (o *SearchCriteria) SetIncludeNested(v bool)` + +SetIncludeNested sets IncludeNested field to given value. + +### HasIncludeNested + +`func (o *SearchCriteria) HasIncludeNested() bool` + +HasIncludeNested returns a boolean if a field has been set. + +### GetSort + +`func (o *SearchCriteria) GetSort() []string` + +GetSort returns the Sort field if non-nil, zero value otherwise. + +### GetSortOk + +`func (o *SearchCriteria) GetSortOk() (*[]string, bool)` + +GetSortOk returns a tuple with the Sort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSort + +`func (o *SearchCriteria) SetSort(v []string)` + +SetSort sets Sort field to given value. + +### HasSort + +`func (o *SearchCriteria) HasSort() bool` + +HasSort returns a boolean if a field has been set. + +### GetSearchAfter + +`func (o *SearchCriteria) GetSearchAfter() []string` + +GetSearchAfter returns the SearchAfter field if non-nil, zero value otherwise. + +### GetSearchAfterOk + +`func (o *SearchCriteria) GetSearchAfterOk() (*[]string, bool)` + +GetSearchAfterOk returns a tuple with the SearchAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchAfter + +`func (o *SearchCriteria) SetSearchAfter(v []string)` + +SetSearchAfter sets SearchAfter field to given value. + +### HasSearchAfter + +`func (o *SearchCriteria) HasSearchAfter() bool` + +HasSearchAfter returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..cc9b1073a --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,116 @@ +--- +id: v2025-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValue', 'V2025SearchCriteriaFiltersValue'] +slug: /tools/sdk/go/v2025/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2025SearchCriteriaFiltersValue'] +--- + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of filter, e.g., \"TERMS\" or \"RANGE\". | [optional] +**Terms** | Pointer to **[]string** | Terms to filter by (for \"TERMS\" type). | [optional] +**Range** | Pointer to [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValue + +`func NewSearchCriteriaFiltersValue() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValue instantiates a new SearchCriteriaFiltersValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueWithDefaults + +`func NewSearchCriteriaFiltersValueWithDefaults() *SearchCriteriaFiltersValue` + +NewSearchCriteriaFiltersValueWithDefaults instantiates a new SearchCriteriaFiltersValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *SearchCriteriaFiltersValue) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *SearchCriteriaFiltersValue) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *SearchCriteriaFiltersValue) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *SearchCriteriaFiltersValue) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetTerms + +`func (o *SearchCriteriaFiltersValue) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaFiltersValue) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaFiltersValue) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaFiltersValue) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetRange + +`func (o *SearchCriteriaFiltersValue) GetRange() SearchCriteriaFiltersValueRange` + +GetRange returns the Range field if non-nil, zero value otherwise. + +### GetRangeOk + +`func (o *SearchCriteriaFiltersValue) GetRangeOk() (*SearchCriteriaFiltersValueRange, bool)` + +GetRangeOk returns a tuple with the Range field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRange + +`func (o *SearchCriteriaFiltersValue) SetRange(v SearchCriteriaFiltersValueRange)` + +SetRange sets Range field to given value. + +### HasRange + +`func (o *SearchCriteriaFiltersValue) HasRange() bool` + +HasRange returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..97f6d7178 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,90 @@ +--- +id: v2025-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2025SearchCriteriaFiltersValueRange'] +slug: /tools/sdk/go/v2025/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2025SearchCriteriaFiltersValueRange'] +--- + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | Pointer to [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Methods + +### NewSearchCriteriaFiltersValueRange + +`func NewSearchCriteriaFiltersValueRange() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRange instantiates a new SearchCriteriaFiltersValueRange object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeWithDefaults + +`func NewSearchCriteriaFiltersValueRangeWithDefaults() *SearchCriteriaFiltersValueRange` + +NewSearchCriteriaFiltersValueRangeWithDefaults instantiates a new SearchCriteriaFiltersValueRange object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLower + +`func (o *SearchCriteriaFiltersValueRange) GetLower() SearchCriteriaFiltersValueRangeLower` + +GetLower returns the Lower field if non-nil, zero value otherwise. + +### GetLowerOk + +`func (o *SearchCriteriaFiltersValueRange) GetLowerOk() (*SearchCriteriaFiltersValueRangeLower, bool)` + +GetLowerOk returns a tuple with the Lower field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLower + +`func (o *SearchCriteriaFiltersValueRange) SetLower(v SearchCriteriaFiltersValueRangeLower)` + +SetLower sets Lower field to given value. + +### HasLower + +`func (o *SearchCriteriaFiltersValueRange) HasLower() bool` + +HasLower returns a boolean if a field has been set. + +### GetUpper + +`func (o *SearchCriteriaFiltersValueRange) GetUpper() SearchCriteriaFiltersValueRangeUpper` + +GetUpper returns the Upper field if non-nil, zero value otherwise. + +### GetUpperOk + +`func (o *SearchCriteriaFiltersValueRange) GetUpperOk() (*SearchCriteriaFiltersValueRangeUpper, bool)` + +GetUpperOk returns a tuple with the Upper field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpper + +`func (o *SearchCriteriaFiltersValueRange) SetUpper(v SearchCriteriaFiltersValueRangeUpper)` + +SetUpper sets Upper field to given value. + +### HasUpper + +`func (o *SearchCriteriaFiltersValueRange) HasUpper() bool` + +HasUpper returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..27a64c050 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,90 @@ +--- +id: v2025-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2025SearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/go/v2025/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2025SearchCriteriaFiltersValueRangeLower'] +--- + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The lower bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the lower bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeLower + +`func NewSearchCriteriaFiltersValueRangeLower() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLower instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeLowerWithDefaults + +`func NewSearchCriteriaFiltersValueRangeLowerWithDefaults() *SearchCriteriaFiltersValueRangeLower` + +NewSearchCriteriaFiltersValueRangeLowerWithDefaults instantiates a new SearchCriteriaFiltersValueRangeLower object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeLower) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeLower) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeLower) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeLower) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..d48404cb4 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,90 @@ +--- +id: v2025-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2025SearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/go/v2025/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2025SearchCriteriaFiltersValueRangeUpper'] +--- + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **string** | The upper bound value. | [optional] +**Inclusive** | Pointer to **bool** | Whether the upper bound is inclusive. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaFiltersValueRangeUpper + +`func NewSearchCriteriaFiltersValueRangeUpper() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpper instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaFiltersValueRangeUpperWithDefaults + +`func NewSearchCriteriaFiltersValueRangeUpperWithDefaults() *SearchCriteriaFiltersValueRangeUpper` + +NewSearchCriteriaFiltersValueRangeUpperWithDefaults instantiates a new SearchCriteriaFiltersValueRangeUpper object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetValueOk() (*string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetValue(v string)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusive() bool` + +GetInclusive returns the Inclusive field if non-nil, zero value otherwise. + +### GetInclusiveOk + +`func (o *SearchCriteriaFiltersValueRangeUpper) GetInclusiveOk() (*bool, bool)` + +GetInclusiveOk returns a tuple with the Inclusive field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) SetInclusive(v bool)` + +SetInclusive sets Inclusive field to given value. + +### HasInclusive + +`func (o *SearchCriteriaFiltersValueRangeUpper) HasInclusive() bool` + +HasInclusive returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaQuery.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..11cf2b69d --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaQuery.md @@ -0,0 +1,64 @@ +--- +id: v2025-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaQuery', 'V2025SearchCriteriaQuery'] +slug: /tools/sdk/go/v2025/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2025SearchCriteriaQuery'] +--- + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **string** | A structured query for advanced search. | [optional] + +## Methods + +### NewSearchCriteriaQuery + +`func NewSearchCriteriaQuery() *SearchCriteriaQuery` + +NewSearchCriteriaQuery instantiates a new SearchCriteriaQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaQueryWithDefaults + +`func NewSearchCriteriaQueryWithDefaults() *SearchCriteriaQuery` + +NewSearchCriteriaQueryWithDefaults instantiates a new SearchCriteriaQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuery + +`func (o *SearchCriteriaQuery) GetQuery() string` + +GetQuery returns the Query field if non-nil, zero value otherwise. + +### GetQueryOk + +`func (o *SearchCriteriaQuery) GetQueryOk() (*string, bool)` + +GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuery + +`func (o *SearchCriteriaQuery) SetQuery(v string)` + +SetQuery sets Query field to given value. + +### HasQuery + +`func (o *SearchCriteriaQuery) HasQuery() bool` + +HasQuery returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..eef30b671 --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,116 @@ +--- +id: v2025-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SearchCriteriaTextQuery', 'V2025SearchCriteriaTextQuery'] +slug: /tools/sdk/go/v2025/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2025SearchCriteriaTextQuery'] +--- + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | Pointer to **[]string** | Terms to search for. | [optional] +**Fields** | Pointer to **[]string** | Fields to search within. | [optional] +**MatchAny** | Pointer to **bool** | Whether to match any of the terms. | [optional] [default to false] + +## Methods + +### NewSearchCriteriaTextQuery + +`func NewSearchCriteriaTextQuery() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQuery instantiates a new SearchCriteriaTextQuery object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSearchCriteriaTextQueryWithDefaults + +`func NewSearchCriteriaTextQueryWithDefaults() *SearchCriteriaTextQuery` + +NewSearchCriteriaTextQueryWithDefaults instantiates a new SearchCriteriaTextQuery object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTerms + +`func (o *SearchCriteriaTextQuery) GetTerms() []string` + +GetTerms returns the Terms field if non-nil, zero value otherwise. + +### GetTermsOk + +`func (o *SearchCriteriaTextQuery) GetTermsOk() (*[]string, bool)` + +GetTermsOk returns a tuple with the Terms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTerms + +`func (o *SearchCriteriaTextQuery) SetTerms(v []string)` + +SetTerms sets Terms field to given value. + +### HasTerms + +`func (o *SearchCriteriaTextQuery) HasTerms() bool` + +HasTerms returns a boolean if a field has been set. + +### GetFields + +`func (o *SearchCriteriaTextQuery) GetFields() []string` + +GetFields returns the Fields field if non-nil, zero value otherwise. + +### GetFieldsOk + +`func (o *SearchCriteriaTextQuery) GetFieldsOk() (*[]string, bool)` + +GetFieldsOk returns a tuple with the Fields field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFields + +`func (o *SearchCriteriaTextQuery) SetFields(v []string)` + +SetFields sets Fields field to given value. + +### HasFields + +`func (o *SearchCriteriaTextQuery) HasFields() bool` + +HasFields returns a boolean if a field has been set. + +### GetMatchAny + +`func (o *SearchCriteriaTextQuery) GetMatchAny() bool` + +GetMatchAny returns the MatchAny field if non-nil, zero value otherwise. + +### GetMatchAnyOk + +`func (o *SearchCriteriaTextQuery) GetMatchAnyOk() (*bool, bool)` + +GetMatchAnyOk returns a tuple with the MatchAny field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMatchAny + +`func (o *SearchCriteriaTextQuery) SetMatchAny(v bool)` + +SetMatchAny sets MatchAny field to given value. + +### HasMatchAny + +`func (o *SearchCriteriaTextQuery) HasMatchAny() bool` + +HasMatchAny returns a boolean if a field has been set. + + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRecord.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRecord.md new file mode 100644 index 000000000..f3de15c4e --- /dev/null +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRecord.md @@ -0,0 +1,302 @@ +--- +id: v2025-sed-batch-record +title: SedBatchRecord +pagination_label: SedBatchRecord +sidebar_label: SedBatchRecord +sidebar_class_name: gosdk +keywords: ['go', 'Golang', 'sdk', 'SedBatchRecord', 'V2025SedBatchRecord'] +slug: /tools/sdk/go/v2025/models/sed-batch-record +tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2025SedBatchRecord'] +--- + +# SedBatchRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TenantId** | Pointer to **string** | The tenant ID associated with the batch. | [optional] +**BatchId** | Pointer to **string** | The unique ID of the batch. | [optional] +**Name** | Pointer to **NullableString** | The name of the batch. | [optional] +**ProcessedState** | Pointer to **NullableString** | The current state of the batch (e.g., submitted, materialized, completed). | [optional] +**RequestedBy** | Pointer to **string** | The ID of the user who requested the batch. | [optional] +**MaterializedCount** | Pointer to **int32** | The number of items materialized in the batch. | [optional] +**ProcessedCount** | Pointer to **int32** | The number of items processed in the batch. | [optional] +**CreatedAt** | Pointer to **SailPointTime** | The timestamp when the batch was created. | [optional] +**UpdatedAt** | Pointer to **NullableTime** | The timestamp when the batch was last updated. | [optional] + +## Methods + +### NewSedBatchRecord + +`func NewSedBatchRecord() *SedBatchRecord` + +NewSedBatchRecord instantiates a new SedBatchRecord object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewSedBatchRecordWithDefaults + +`func NewSedBatchRecordWithDefaults() *SedBatchRecord` + +NewSedBatchRecordWithDefaults instantiates a new SedBatchRecord object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTenantId + +`func (o *SedBatchRecord) GetTenantId() string` + +GetTenantId returns the TenantId field if non-nil, zero value otherwise. + +### GetTenantIdOk + +`func (o *SedBatchRecord) GetTenantIdOk() (*string, bool)` + +GetTenantIdOk returns a tuple with the TenantId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTenantId + +`func (o *SedBatchRecord) SetTenantId(v string)` + +SetTenantId sets TenantId field to given value. + +### HasTenantId + +`func (o *SedBatchRecord) HasTenantId() bool` + +HasTenantId returns a boolean if a field has been set. + +### GetBatchId + +`func (o *SedBatchRecord) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *SedBatchRecord) GetBatchIdOk() (*string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBatchId + +`func (o *SedBatchRecord) SetBatchId(v string)` + +SetBatchId sets BatchId field to given value. + +### HasBatchId + +`func (o *SedBatchRecord) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### GetName + +`func (o *SedBatchRecord) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *SedBatchRecord) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *SedBatchRecord) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *SedBatchRecord) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *SedBatchRecord) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *SedBatchRecord) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetProcessedState + +`func (o *SedBatchRecord) GetProcessedState() string` + +GetProcessedState returns the ProcessedState field if non-nil, zero value otherwise. + +### GetProcessedStateOk + +`func (o *SedBatchRecord) GetProcessedStateOk() (*string, bool)` + +GetProcessedStateOk returns a tuple with the ProcessedState field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedState + +`func (o *SedBatchRecord) SetProcessedState(v string)` + +SetProcessedState sets ProcessedState field to given value. + +### HasProcessedState + +`func (o *SedBatchRecord) HasProcessedState() bool` + +HasProcessedState returns a boolean if a field has been set. + +### SetProcessedStateNil + +`func (o *SedBatchRecord) SetProcessedStateNil(b bool)` + + SetProcessedStateNil sets the value for ProcessedState to be an explicit nil + +### UnsetProcessedState +`func (o *SedBatchRecord) UnsetProcessedState()` + +UnsetProcessedState ensures that no value is present for ProcessedState, not even an explicit nil +### GetRequestedBy + +`func (o *SedBatchRecord) GetRequestedBy() string` + +GetRequestedBy returns the RequestedBy field if non-nil, zero value otherwise. + +### GetRequestedByOk + +`func (o *SedBatchRecord) GetRequestedByOk() (*string, bool)` + +GetRequestedByOk returns a tuple with the RequestedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRequestedBy + +`func (o *SedBatchRecord) SetRequestedBy(v string)` + +SetRequestedBy sets RequestedBy field to given value. + +### HasRequestedBy + +`func (o *SedBatchRecord) HasRequestedBy() bool` + +HasRequestedBy returns a boolean if a field has been set. + +### GetMaterializedCount + +`func (o *SedBatchRecord) GetMaterializedCount() int32` + +GetMaterializedCount returns the MaterializedCount field if non-nil, zero value otherwise. + +### GetMaterializedCountOk + +`func (o *SedBatchRecord) GetMaterializedCountOk() (*int32, bool)` + +GetMaterializedCountOk returns a tuple with the MaterializedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMaterializedCount + +`func (o *SedBatchRecord) SetMaterializedCount(v int32)` + +SetMaterializedCount sets MaterializedCount field to given value. + +### HasMaterializedCount + +`func (o *SedBatchRecord) HasMaterializedCount() bool` + +HasMaterializedCount returns a boolean if a field has been set. + +### GetProcessedCount + +`func (o *SedBatchRecord) GetProcessedCount() int32` + +GetProcessedCount returns the ProcessedCount field if non-nil, zero value otherwise. + +### GetProcessedCountOk + +`func (o *SedBatchRecord) GetProcessedCountOk() (*int32, bool)` + +GetProcessedCountOk returns a tuple with the ProcessedCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProcessedCount + +`func (o *SedBatchRecord) SetProcessedCount(v int32)` + +SetProcessedCount sets ProcessedCount field to given value. + +### HasProcessedCount + +`func (o *SedBatchRecord) HasProcessedCount() bool` + +HasProcessedCount returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *SedBatchRecord) GetCreatedAt() SailPointTime` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *SedBatchRecord) GetCreatedAtOk() (*SailPointTime, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *SedBatchRecord) SetCreatedAt(v SailPointTime)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *SedBatchRecord) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *SedBatchRecord) GetUpdatedAt() SailPointTime` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *SedBatchRecord) GetUpdatedAtOk() (*SailPointTime, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *SedBatchRecord) SetUpdatedAt(v SailPointTime)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *SedBatchRecord) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### SetUpdatedAtNil + +`func (o *SedBatchRecord) SetUpdatedAtNil(b bool)` + + SetUpdatedAtNil sets the value for UpdatedAt to be an explicit nil + +### UnsetUpdatedAt +`func (o *SedBatchRecord) UnsetUpdatedAt()` + +UnsetUpdatedAt ensures that no value is present for UpdatedAt, not even an explicit nil + diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md index 593d4dfad..77873f288 100644 --- a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md +++ b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchRequest.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | Pointer to **[]string** | list of entitlement ids | [optional] **Seds** | Pointer to **[]string** | list of sed ids | [optional] +**SearchCriteria** | Pointer to [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Methods @@ -62,6 +63,16 @@ SetEntitlements sets Entitlements field to given value. HasEntitlements returns a boolean if a field has been set. +### SetEntitlementsNil + +`func (o *SedBatchRequest) SetEntitlementsNil(b bool)` + + SetEntitlementsNil sets the value for Entitlements to be an explicit nil + +### UnsetEntitlements +`func (o *SedBatchRequest) UnsetEntitlements()` + +UnsetEntitlements ensures that no value is present for Entitlements, not even an explicit nil ### GetSeds `func (o *SedBatchRequest) GetSeds() []string` @@ -87,4 +98,49 @@ SetSeds sets Seds field to given value. HasSeds returns a boolean if a field has been set. +### SetSedsNil + +`func (o *SedBatchRequest) SetSedsNil(b bool)` + + SetSedsNil sets the value for Seds to be an explicit nil + +### UnsetSeds +`func (o *SedBatchRequest) UnsetSeds()` + +UnsetSeds ensures that no value is present for Seds, not even an explicit nil +### GetSearchCriteria + +`func (o *SedBatchRequest) GetSearchCriteria() map[string]SearchCriteria` + +GetSearchCriteria returns the SearchCriteria field if non-nil, zero value otherwise. + +### GetSearchCriteriaOk + +`func (o *SedBatchRequest) GetSearchCriteriaOk() (*map[string]SearchCriteria, bool)` + +GetSearchCriteriaOk returns a tuple with the SearchCriteria field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSearchCriteria + +`func (o *SedBatchRequest) SetSearchCriteria(v map[string]SearchCriteria)` + +SetSearchCriteria sets SearchCriteria field to given value. + +### HasSearchCriteria + +`func (o *SedBatchRequest) HasSearchCriteria() bool` + +HasSearchCriteria returns a boolean if a field has been set. + +### SetSearchCriteriaNil + +`func (o *SedBatchRequest) SetSearchCriteriaNil(b bool)` + + SetSearchCriteriaNil sets the value for SearchCriteria to be an explicit nil + +### UnsetSearchCriteria +`func (o *SedBatchRequest) UnsetSearchCriteria()` + +UnsetSearchCriteria ensures that no value is present for SearchCriteria, not even an explicit nil diff --git a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md b/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md deleted file mode 100644 index 8aeaf6591..000000000 --- a/docs/tools/sdk/go/Reference/V2025/Models/SedBatchStatus.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: v2025-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: gosdk -keywords: ['go', 'Golang', 'sdk', 'SedBatchStatus', 'V2025SedBatchStatus'] -slug: /tools/sdk/go/v2025/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2025SedBatchStatus'] ---- - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **string** | status of batch | [optional] - -## Methods - -### NewSedBatchStatus - -`func NewSedBatchStatus() *SedBatchStatus` - -NewSedBatchStatus instantiates a new SedBatchStatus object -This constructor will assign default values to properties that have it defined, -and makes sure properties required by API are set, but the set of arguments -will change when the set of required properties is changed - -### NewSedBatchStatusWithDefaults - -`func NewSedBatchStatusWithDefaults() *SedBatchStatus` - -NewSedBatchStatusWithDefaults instantiates a new SedBatchStatus object -This constructor will only assign default values to properties that have it defined, -but it doesn't guarantee that properties required by API are set - -### GetStatus - -`func (o *SedBatchStatus) GetStatus() string` - -GetStatus returns the Status field if non-nil, zero value otherwise. - -### GetStatusOk - -`func (o *SedBatchStatus) GetStatusOk() (*string, bool)` - -GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### SetStatus - -`func (o *SedBatchStatus) SetStatus(v string)` - -SetStatus sets Status field to given value. - -### HasStatus - -`func (o *SedBatchStatus) HasStatus() bool` - -HasStatus returns a boolean if a field has been set. - - diff --git a/static/code-examples/beta/go_code_examples_overlay.yaml b/static/code-examples/beta/go_code_examples_overlay.yaml index 09d7614a4..c8086d6f9 100644 --- a/static/code-examples/beta/go_code_examples_overlay.yaml +++ b/static/code-examples/beta/go_code_examples_overlay.yaml @@ -19956,6 +19956,11 @@ ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) @@ -19963,12 +19968,12 @@ configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.Beta.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []Sed fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } - path: /suggested-entitlement-descriptions @@ -20158,7 +20163,30 @@ func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional) diff --git a/static/code-examples/v2024/go_code_examples_overlay.yaml b/static/code-examples/v2024/go_code_examples_overlay.yaml index 58c0d8c94..b4bc8fefa 100644 --- a/static/code-examples/v2024/go_code_examples_overlay.yaml +++ b/static/code-examples/v2024/go_code_examples_overlay.yaml @@ -26339,6 +26339,11 @@ ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) @@ -26346,12 +26351,12 @@ configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2024.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []SedBatchRecord fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } - path: /suggested-entitlement-descriptions @@ -26542,7 +26547,30 @@ func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional) diff --git a/static/code-examples/v2025/go_code_examples_overlay.yaml b/static/code-examples/v2025/go_code_examples_overlay.yaml index c2a09a326..12f48c594 100644 --- a/static/code-examples/v2025/go_code_examples_overlay.yaml +++ b/static/code-examples/v2025/go_code_examples_overlay.yaml @@ -26036,6 +26036,11 @@ ) func main() { + offset := 0 // int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit := 250 // int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + count := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + countOnly := true // bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) # bool | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + status := `completed, failed, submitted, materialized, failed` // string | Batch Status (optional) # string | Batch Status (optional) @@ -26043,12 +26048,12 @@ configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() - //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Execute() + //resp, r, err := apiClient.V2025.SuggestedEntitlementDescriptionAPI.GetSedBatches(context.Background()).Offset(offset).Limit(limit).Count(count).CountOnly(countOnly).Status(status).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SuggestedEntitlementDescriptionAPI.GetSedBatches``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GetSedBatches`: SedBatchStatus + // response from `GetSedBatches`: []SedBatchRecord fmt.Fprintf(os.Stdout, "Response from `SuggestedEntitlementDescriptionAPI.GetSedBatches`: %v\n", resp) } - path: /suggested-entitlement-descriptions @@ -26239,7 +26244,30 @@ func main() { sedbatchrequest := []byte(`{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }`) // SedBatchRequest | Sed Batch Request (optional)