1 Star 0 Fork 0

justapnet / justap-server-sdk-go

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
CustomerServiceApi.md 9.09 KB
一键复制 编辑 原始数据 按行查看 历史
justap-bot 提交于 2023-12-07 15:05 . new release 3.0.0

\CustomerServiceApi

All URIs are relative to http://127.0.0.1:21011

Method HTTP request Description
CustomerServiceCreateCustomer Post /v1/customers
CustomerServiceDeleteCustomer Delete /v1/customers/{id}
CustomerServiceListAllCustomers Get /v1/customers
CustomerServiceRetrieveCustomer Get /v1/customers/{id}
CustomerServiceSearchCustomers Get /v1/customers/search
CustomerServiceUpdateCustomer Post /v1/customers/{id}

CustomerServiceCreateCustomer

V1CustomerResponse CustomerServiceCreateCustomer(ctx, body)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body V1CreateCustomerRequest

Return type

V1CustomerResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerServiceDeleteCustomer

V1DeleteCustomerResponse CustomerServiceDeleteCustomer(ctx, id, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
optional *CustomerServiceApiCustomerServiceDeleteCustomerOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomerServiceApiCustomerServiceDeleteCustomerOpts struct

Name Type Description Notes

appId | optional.String| |

Return type

V1DeleteCustomerResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerServiceListAllCustomers

V1CustomerListResponse CustomerServiceListAllCustomers(ctx, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CustomerServiceApiCustomerServiceListAllCustomersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomerServiceApiCustomerServiceListAllCustomersOpts struct

Name Type Description Notes
appId optional.String
limit optional.Int32 [OPTIONAL] 限制有多少对象可以被返回,限制范围是从 1~100 项,默认是 10 项 [default to 10]
startingAfter optional.String [OPTIONAL] 在分页时使用的指针,决定了列表的第一项从何处开始。假设你的一次请求返回列表的最后一项的 id 是 obj_end,你可以使用 starting_after = obj_end 去获取下一页
endingBefore optional.String [OPTIONAL] 在分页时使用的指针,决定了列表的最末项在何处结束。假设你的一次请求返回列表的第一项的 id 是 obj_start,你可以使用 ending_before = obj_start 去获取上一页
createdLt optional.Int64 大于 charge 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdLte optional.Int64 大于或等于 charge 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdGt optional.Int64 小于 charge 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdGte optional.Int64 小于或等于 charge 对象的创建时间,用 Unix 时间戳表示 [default to 0]
disabled optional.Bool [OPTIONAL] 是否禁用,默认为 false

Return type

V1CustomerListResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerServiceRetrieveCustomer

V1CustomerResponse CustomerServiceRetrieveCustomer(ctx, id, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string
optional *CustomerServiceApiCustomerServiceRetrieveCustomerOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomerServiceApiCustomerServiceRetrieveCustomerOpts struct

Name Type Description Notes

appId | optional.String| |

Return type

V1CustomerResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerServiceSearchCustomers

V1CustomerListResponse CustomerServiceSearchCustomers(ctx, optional)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CustomerServiceApiCustomerServiceSearchCustomersOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CustomerServiceApiCustomerServiceSearchCustomersOpts struct

Name Type Description Notes
appId optional.String
limit optional.Int32 [OPTIONAL] 限制有多少对象可以被返回,限制范围是从 1~100 项,默认是 10 项 [default to 10]
createdLt optional.Int64 大于 BusinessUser 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdLte optional.Int64 大于或等于 BusinessUser 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdGt optional.Int64 小于 BusinessUser 对象的创建时间,用 Unix 时间戳表示 [default to 0]
createdGte optional.Int64 小于或等于 BusinessUser 对象的创建时间,用 Unix 时间戳表示 [default to 0]
email optional.String [OPTIONAL] BusinessUser 对象的邮箱地址。支持模糊匹配
name optional.String [OPTIONAL] BusinessUser 对象的用户名。支持模糊匹配
phone optional.String [OPTIONAL] BusinessUser 对象的手机号码

Return type

V1CustomerListResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomerServiceUpdateCustomer

V1CustomerResponse CustomerServiceUpdateCustomer(ctx, id)

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

V1CustomerResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Go
1
https://gitee.com/justapnet/justap-server-sdk-go.git
git@gitee.com:justapnet/justap-server-sdk-go.git
justapnet
justap-server-sdk-go
justap-server-sdk-go
master

搜索帮助