api_apaas_application_object_record_batch_query.go

// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
 * Copyright 2022 chyroc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package lark

import (
	"context"
)

// BatchQueryAPaaSApplicationObjectRecord 获取对象中符合指定条件的记录列表
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/apaas-v1/application-object-record/batch_query
// new doc: https://open.feishu.cn/document/apaas-v1/application-object-record/batch_query
func (r *APaaSService) BatchQueryAPaaSApplicationObjectRecord(ctx context.Context, request *BatchQueryAPaaSApplicationObjectRecordReq, options ...MethodOptionFunc) (*BatchQueryAPaaSApplicationObjectRecordResp, *Response, error) {
	if r.cli.mock.mockAPaaSBatchQueryAPaaSApplicationObjectRecord != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] APaaS#BatchQueryAPaaSApplicationObjectRecord mock enable")
		return r.cli.mock.mockAPaaSBatchQueryAPaaSApplicationObjectRecord(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "APaaS",
		API:                   "BatchQueryAPaaSApplicationObjectRecord",
		Method:                "POST",
		URL:                   r.cli.openBaseURL + "/open-apis/apaas/v1/applications/:namespace/objects/:object_api_name/records/batch_query",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
	}
	resp := new(batchQueryAPaaSApplicationObjectRecordResp)

	response, err := r.cli.RawRequest(ctx, req, resp)
	return resp.Data, response, err
}

// MockAPaaSBatchQueryAPaaSApplicationObjectRecord mock APaaSBatchQueryAPaaSApplicationObjectRecord method
func (r *Mock) MockAPaaSBatchQueryAPaaSApplicationObjectRecord(f func(ctx context.Context, request *BatchQueryAPaaSApplicationObjectRecordReq, options ...MethodOptionFunc) (*BatchQueryAPaaSApplicationObjectRecordResp, *Response, error)) {
	r.mockAPaaSBatchQueryAPaaSApplicationObjectRecord = f
}

// UnMockAPaaSBatchQueryAPaaSApplicationObjectRecord un-mock APaaSBatchQueryAPaaSApplicationObjectRecord method
func (r *Mock) UnMockAPaaSBatchQueryAPaaSApplicationObjectRecord() {
	r.mockAPaaSBatchQueryAPaaSApplicationObjectRecord = nil
}

// BatchQueryAPaaSApplicationObjectRecordReq ...
type BatchQueryAPaaSApplicationObjectRecordReq struct {
	Namespace      string                                              `path:"namespace" json:"-"`         // 命名空间示例值: "package_test__c" 长度范围: `0` ～ `256` 字符
	ObjectApiName  string                                              `path:"object_api_name" json:"-"`   // 目标对象的唯一标识符示例值: "_user" 长度范围: `0` ～ `256` 字符
	Select         []string                                            `json:"select,omitempty"`           // 需要获取的字段, 使用字段唯一标识符进行查询, 关联字段可使用「.」进行下钻示例值: ["_name"] 长度范围: `0` ～ `256`
	Filter         *BatchQueryAPaaSApplicationObjectRecordReqFilter    `json:"filter,omitempty"`           // 筛选条件, 通过 JSON 格式指定条件
	OrderBy        []*BatchQueryAPaaSApplicationObjectRecordReqOrderBy `json:"order_by,omitempty"`         // 排序参数, 通过 JSON 格式指定条件。其中, field 为参与排序字段, direction 为排序方向, 多个条件按其在数组中的顺序生效。 长度范围: `0` ～ `256`
	GroupBy        []*BatchQueryAPaaSApplicationObjectRecordReqGroupBy `json:"group_by,omitempty"`         // 聚合参数, 通过 JSON 格式指定条件。其中, field 为参与聚合的字段。 长度范围: `0` ～ `256`
	PageToken      *string                                             `json:"page_token,omitempty"`       // 分页标记, 第一次请求不填, 表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token, 下次遍历可采用该 page_token 获取查询结果示例值: "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
	UsePageToken   *string                                             `json:"use_page_token,omitempty"`   // 是否使用 page_token 功能。为 True 时将使用 page_token 的值作为起始位置查询记录, 并且会在 Response 中返回 next_page_token 。默认为 False 。示例值: false
	PageSize       *int64                                              `json:"page_size,omitempty"`        // 期望服务端返回的记录条数, 上限 500 条。不填则取默认值, 默认值为 500。示例值: 100
	Offset         *int64                                              `json:"offset,omitempty"`           // 返回记录的偏移量, 默认为 0, 即从查询到的第一条记录开始返回。offset 较大时查询性能较差, 可能引起接口响应超时, 拉取全部记录时建议使用 ID 游标分页, 具体见 ID 游标分页说明示例值: 0 取值范围: `0` ～ `10000000000`
	NeedTotalCount *int64                                              `json:"need_total_count,omitempty"` // 是否返回符合条件的记录总数（Total）。默认为 False, 不返回记录总数。示例值: true
}

// BatchQueryAPaaSApplicationObjectRecordReqFilter ...
type BatchQueryAPaaSApplicationObjectRecordReqFilter struct {
	Conditions      []*BatchQueryAPaaSApplicationObjectRecordReqFilterCondition `json:"conditions,omitempty"`       // 查询条件 长度范围: `0` ～ `10`
	LogicExpression *string                                                     `json:"logic_expression,omitempty"` // 逻辑关系示例值: "1 and 2"
}

// BatchQueryAPaaSApplicationObjectRecordReqFilterCondition ...
type BatchQueryAPaaSApplicationObjectRecordReqFilterCondition struct {
	Index    *string                                                        `json:"index,omitempty"`    // 序号示例值: "1"
	Left     *BatchQueryAPaaSApplicationObjectRecordReqFilterConditionLeft  `json:"left,omitempty"`     // 左值
	Right    *BatchQueryAPaaSApplicationObjectRecordReqFilterConditionRight `json:"right,omitempty"`    // 右值
	Operator *string                                                        `json:"operator,omitempty"` // 操作符示例值: "equals"
}

// BatchQueryAPaaSApplicationObjectRecordReqFilterConditionLeft ...
type BatchQueryAPaaSApplicationObjectRecordReqFilterConditionLeft struct {
	Type     *string `json:"type,omitempty"`     // 左值类型, 只支持 "metadataVariable", 表示字段示例值: "metadataVariable"
	Settings *string `json:"settings,omitempty"` // 字段具体值, 以 JSONString 表示, 格式: {"fieldPath":[{"fieldApiName": "字段名", "objectApiName": "对象名"}]}示例值: "{\"fieldPath\":[{\"fieldApiName\": \"_id\", \"objectApiName\": \"_user\"}]}"
}

// BatchQueryAPaaSApplicationObjectRecordReqFilterConditionRight ...
type BatchQueryAPaaSApplicationObjectRecordReqFilterConditionRight struct {
	Type     *string `json:"type,omitempty"`     // 右值类型, 只支持 "constant", 表示常量示例值: "constant"
	Settings *string `json:"settings,omitempty"` // 常量具体值, 以 JSONString 表示, 格式: {"data":"常量具体值"}示例值: "{\"data\":\"123456\"}"
}

// BatchQueryAPaaSApplicationObjectRecordReqGroupBy ...
type BatchQueryAPaaSApplicationObjectRecordReqGroupBy struct {
	Field string `json:"field,omitempty"` // 字段唯一标识示例值: "_id" 长度范围: `0` ～ `256` 字符
}

// BatchQueryAPaaSApplicationObjectRecordReqOrderBy ...
type BatchQueryAPaaSApplicationObjectRecordReqOrderBy struct {
	Field     string `json:"field,omitempty"`     // 字段唯一标识示例值: "_id" 长度范围: `0` ～ `256` 字符
	Direction string `json:"direction,omitempty"` // 排序方向, 值为 "ASC" 或者 "DESC", 代表升序和降序示例值: "ASC"可选值有: 升序 降序 长度范围: `0` ～ `256` 字符
}

// BatchQueryAPaaSApplicationObjectRecordResp ...
type BatchQueryAPaaSApplicationObjectRecordResp struct {
	Items         []string `json:"items,omitempty"`           // 符合条件的记录列表
	Total         int64    `json:"total,omitempty"`           // 符合条件的记录数
	NextPageToken string   `json:"next_page_token,omitempty"` // 下一页的起始位置 Token, 访问至末尾时不返回
	HasMore       bool     `json:"has_more,omitempty"`        // 是否还有更多项
}

// batchQueryAPaaSApplicationObjectRecordResp ...
type batchQueryAPaaSApplicationObjectRecordResp struct {
	Code  int64                                       `json:"code,omitempty"` // 错误码, 非 0 表示失败
	Msg   string                                      `json:"msg,omitempty"`  // 错误描述
	Data  *BatchQueryAPaaSApplicationObjectRecordResp `json:"data,omitempty"`
	Error *ErrorDetail                                `json:"error,omitempty"`
}