Skip to content

Commit f25ebae

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent f9663a3 commit f25ebae

File tree

79 files changed

+498
-526
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+498
-526
lines changed

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 40
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-38aaadafbb2bf0c5d5bb9330a0a5e7a89052fe3e791569c8a12051e040193edf.yml
3-
openapi_spec_hash: 2d35c1223beebaf2c1b8d8a474cbf7c2
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-2566cdc5d8e0bffe2a8c442692b0fc1b35d3bfe7e9bf578331fc19d402361c1f.yml
3+
openapi_spec_hash: 85e1feeb9bbc8d59bb34d6cdd679575a
44
config_hash: ad652575976c2c8db09e4575778f0e77

‎lib/sentdm/models/api_response_of_contact.rb‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ module Models
55
# @see Sentdm::Resources::Contacts#create
66
class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
77
# @!attribute data
8-
# The response data (null if error)
8+
# Contact response for v3 API Uses snake_case for JSON property names
99
#
1010
# @return [Sentdm::Models::ContactResponse, nil]
1111
optional :data, -> { Sentdm::ContactResponse }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -29,13 +29,16 @@ class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
2929
optional :success, Sentdm::Internal::Type::Boolean
3030

3131
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32+
# Some parameter documentations has been truncated, see
33+
# {Sentdm::Models::APIResponseOfContact} for more details.
34+
#
3235
# Standard API response envelope for all v3 endpoints
3336
#
34-
# @param data [Sentdm::Models::ContactResponse, nil] The response data (null if error)
37+
# @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
3538
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
39+
# @param error [Sentdm::Models::APIError, nil] Error information
3740
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
41+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3942
#
4043
# @param success [Boolean] Indicates whether the request was successful
4144
end

‎lib/sentdm/models/api_response_of_profile_detail.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ module Models
55
# @see Sentdm::Resources::Profiles#create
66
class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
77
# @!attribute data
8-
# The response data (null if error)
8+
# Detailed profile response for v3 API
99
#
1010
# @return [Sentdm::Models::ProfileDetail, nil]
1111
optional :data, -> { Sentdm::ProfileDetail }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
3131
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
3232
# Standard API response envelope for all v3 endpoints
3333
#
34-
# @param data [Sentdm::Models::ProfileDetail, nil] The response data (null if error)
34+
# @param data [Sentdm::Models::ProfileDetail, nil] Detailed profile response for v3 API
3535
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36+
# @param error [Sentdm::Models::APIError, nil] Error information
3737
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3939
#
4040
# @param success [Boolean] Indicates whether the request was successful
4141
end

‎lib/sentdm/models/api_response_of_user.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ module Models
55
# @see Sentdm::Resources::Users#retrieve
66
class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
77
# @!attribute data
8-
# The response data (null if error)
8+
# User response for v3 API
99
#
1010
# @return [Sentdm::Models::UserResponse, nil]
1111
optional :data, -> { Sentdm::UserResponse }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
3131
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
3232
# Standard API response envelope for all v3 endpoints
3333
#
34-
# @param data [Sentdm::Models::UserResponse, nil] The response data (null if error)
34+
# @param data [Sentdm::Models::UserResponse, nil] User response for v3 API
3535
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36+
# @param error [Sentdm::Models::APIError, nil] Error information
3737
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3939
#
4040
# @param success [Boolean] Indicates whether the request was successful
4141
end

‎lib/sentdm/models/api_response_template.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ module Models
55
# @see Sentdm::Resources::Templates#create
66
class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
77
# @!attribute data
8-
# The response data (null if error)
8+
# Template response for v3 API
99
#
1010
# @return [Sentdm::Models::Template, nil]
1111
optional :data, -> { Sentdm::Template }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
3131
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
3232
# Standard API response envelope for all v3 endpoints
3333
#
34-
# @param data [Sentdm::Models::Template, nil] The response data (null if error)
34+
# @param data [Sentdm::Models::Template, nil] Template response for v3 API
3535
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36+
# @param error [Sentdm::Models::APIError, nil] Error information
3737
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3939
#
4040
# @param success [Boolean] Indicates whether the request was successful
4141
end

‎lib/sentdm/models/api_response_webhook.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
1111
optional :data, -> { Sentdm::WebhookResponse }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
3333
#
3434
# @param data [Sentdm::Models::WebhookResponse, nil] The response data (null if error)
3535
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36+
# @param error [Sentdm::Models::APIError, nil] Error information
3737
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3939
#
4040
# @param success [Boolean] Indicates whether the request was successful
4141
end

‎lib/sentdm/models/brands_brand_data.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ module Sentdm
44
module Models
55
class BrandsBrandData < Sentdm::Internal::Type::BaseModel
66
# @!attribute compliance
7-
# Compliance and TCR-related information
7+
# Compliance and TCR information for brand registration
88
#
99
# @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
1010
required :compliance,
1111
-> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
1212

1313
# @!attribute contact
14-
# Contact information for the brand
14+
# Contact information for brand KYC
1515
#
1616
# @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
1717
required :contact,
1818
-> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
1919

2020
# @!attribute business
21-
# Business details and address information
21+
# Business details and address for brand KYC
2222
#
2323
# @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
2424
optional :business,
@@ -28,11 +28,11 @@ class BrandsBrandData < Sentdm::Internal::Type::BaseModel
2828
# @!method initialize(compliance:, contact:, business: nil)
2929
# Brand and KYC data grouped into contact, business, and compliance sections
3030
#
31-
# @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR-related information
31+
# @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR information for brand registration
3232
#
33-
# @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for the brand
33+
# @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
3434
#
35-
# @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address information
35+
# @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
3636
end
3737
end
3838
end

‎lib/sentdm/models/contact_list_response.rb‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ module Models
55
# @see Sentdm::Resources::Contacts#list
66
class ContactListResponse < Sentdm::Internal::Type::BaseModel
77
# @!attribute data
8-
# The response data (null if error)
8+
# Paginated list of contacts response
99
#
1010
# @return [Sentdm::Models::ContactListResponse::Data, nil]
1111
optional :data, -> { Sentdm::Models::ContactListResponse::Data }, nil?: true
1212

1313
# @!attribute error
14-
# Error details (null if successful)
14+
# Error information
1515
#
1616
# @return [Sentdm::Models::APIError, nil]
1717
optional :error, -> { Sentdm::APIError }, nil?: true
1818

1919
# @!attribute meta
20-
# Metadata about the request and response
20+
# Request and response metadata
2121
#
2222
# @return [Sentdm::Models::APIMeta, nil]
2323
optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ class ContactListResponse < Sentdm::Internal::Type::BaseModel
3131
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
3232
# Standard API response envelope for all v3 endpoints
3333
#
34-
# @param data [Sentdm::Models::ContactListResponse::Data, nil] The response data (null if error)
34+
# @param data [Sentdm::Models::ContactListResponse::Data, nil] Paginated list of contacts response
3535
#
36-
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36+
# @param error [Sentdm::Models::APIError, nil] Error information
3737
#
38-
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
3939
#
4040
# @param success [Boolean] Indicates whether the request was successful
4141

@@ -48,17 +48,17 @@ class Data < Sentdm::Internal::Type::BaseModel
4848
optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
4949

5050
# @!attribute pagination
51-
# Pagination metadata
51+
# Pagination metadata for list responses
5252
#
5353
# @return [Sentdm::Models::PaginationMeta, nil]
5454
optional :pagination, -> { Sentdm::PaginationMeta }
5555

5656
# @!method initialize(contacts: nil, pagination: nil)
57-
# The response data (null if error)
57+
# Paginated list of contacts response
5858
#
5959
# @param contacts [Array<Sentdm::Models::ContactResponse>] List of contacts
6060
#
61-
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
61+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
6262
end
6363
end
6464
end

0 commit comments

Comments
 (0)